org.dishevelled.piccolo.venn

Class VennNode<E>

java.lang.Object

org.piccolo2d.PNode

org.dishevelled.piccolo.venn.AbstractVennNode<E>

org.dishevelled.piccolo.venn.VennNode<E>

Type Parameters:

E - value type

All Implemented Interfaces:

Printable, Serializable, Cloneable

public class VennNode<E>
extends AbstractVennNode<E>

Venn diagram node.

Author:

Michael Heuer

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.piccolo2d.PNode

org.piccolo2d.PNode.PSceneGraphDelegate

Field Summary

Fields inherited from class org.piccolo2d.PNode

FILL_STRATEGY_ASPECT_COVER, FILL_STRATEGY_ASPECT_FIT, FILL_STRATEGY_EXACT_FIT, PROPERTY_BOUNDS, PROPERTY_CHILDREN, PROPERTY_CHILDREN_PICKABLE, PROPERTY_CLIENT_PROPERTIES, PROPERTY_CODE_BOUNDS, PROPERTY_CODE_CHILDREN, PROPERTY_CODE_CHILDREN_PICKABLE, PROPERTY_CODE_CLIENT_PROPERTIES, PROPERTY_CODE_FULL_BOUNDS, PROPERTY_CODE_PAINT, PROPERTY_CODE_PARENT, PROPERTY_CODE_PICKABLE, PROPERTY_CODE_TRANSFORM, PROPERTY_CODE_TRANSPARENCY, PROPERTY_CODE_VISIBLE, PROPERTY_FULL_BOUNDS, PROPERTY_PAINT, PROPERTY_PARENT, PROPERTY_PICKABLE, PROPERTY_TRANSFORM, PROPERTY_TRANSPARENCY, PROPERTY_VISIBLE, SCENE_GRAPH_DELEGATE

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Constructor Summary

Constructors

Constructor and Description
VennNode(VennModel<E> model) Create a new venn node with the specified model.

Method Summary

Methods

Modifier and Type	Method and Description
(package private) static int[]	additional(org.dishevelled.bitset.ImmutableBitSet bitSet) Return the additional indices set to true in the specified bit set.
(package private) static int[]	additional(Set<Integer> values) Return the additional int values in the specified set of values.
protected String	buildAreaLabel(int index, int... additional) Build and return area label text.
(package private) static int	first(org.dishevelled.bitset.ImmutableBitSet bitSet) Return the first index set to true in the specified bit set.
(package private) static int	first(Set<Integer> values) Return the first int value in the specified set of values.
org.piccolo2d.nodes.PArea	getArea(int index, int... additional) Return the area node for the intersecting area defined by the specified indices.
String	getAreaLabelText(int index, int... additional) Return the area label text for the intersecting area defined by the specified indices.
org.piccolo2d.nodes.PText	getLabel(int index) Return the label for the set at the specified index.
String	getLabelText(int index) Return the label text for the set at the specified index.
VennLayout	getLayout() Return the layout for this venn node.
VennModel<E>	getModel() Return the model for this venn node.
org.piccolo2d.nodes.PPath	getPath(int index) Return the path node for the set at the specified index.
org.piccolo2d.nodes.PText	getSizeLabel(int index, int... additional) Return the size label for the intersecting area defined by the specified indices.
org.piccolo2d.nodes.PText	labelForNode(org.piccolo2d.PNode node) Return the label for the specified node, if any.
Iterable<org.piccolo2d.nodes.PText>	labels() Return the labels for this venn diagram node.
String	labelTextForNode(org.piccolo2d.PNode node) Return the label text for the specified node, if any.
Iterable<org.piccolo2d.PNode>	nodes() Return the nodes for this venn diagram node.
(package private) static com.google.common.collect.ImmutableSet<Integer>	range(int n) Return an immutable set of the integers between 0 and n, exclusive.
void	setLabelText(int index, String labelText) Set the label text for the set at the specified index to labelText.
void	setLayout(VennLayout layout) Set the layout for this venn node to layout.
int	size() Return the size of this venn node.
Iterable<org.piccolo2d.nodes.PText>	sizeLabels() Return the size labels for this venn diagram node.
(package private) static org.dishevelled.bitset.ImmutableBitSet	toImmutableBitSet(int index, int... additional) Create and return a new immutable bit set with the specified bits set to true.
(package private) static org.dishevelled.bitset.ImmutableBitSet	toImmutableBitSet(Set<Integer> indices) Create and return a new immutable bit set with the specified bits set to true.
protected void	updateLabels() Update labels.
Set<E>	viewForNode(org.piccolo2d.PNode node) Return the view for the specified node, if any.

Methods inherited from class org.dishevelled.piccolo.venn.AbstractVennNode

buildLabel, getDisplayLabels, getDisplaySizeLabels, getDisplaySizes, getDisplaySizesForEmptyAreas, setDisplayLabels, setDisplaySizeLabels, setDisplaySizes, setDisplaySizesForEmptyAreas

Methods inherited from class org.piccolo2d.PNode

addActivity, addAttribute, addChild, addChild, addChildren, addInputEventListener, addPropertyChangeListener, addPropertyChangeListener, animateToBounds, animateToColor, animateToPositionScaleRotation, animateToRelativePosition, animateToTransform, animateToTransparency, animateTransformToBounds, centerBoundsOnPoint, centerFullBoundsOnPoint, clone, computeFullBounds, endResizeBounds, findIntersectingNodes, fireChildPropertyChange, firePropertyChange, fullIntersects, fullPaint, fullPick, getAllNodes, getAllNodes, getAttribute, getAttribute, getBooleanAttribute, getBounds, getBoundsChanged, getBoundsReference, getBoundsVolatile, getChild, getChildBoundsInvalid, getChildBoundsVolatile, getChildPaintInvalid, getChildrenCount, getChildrenIterator, getChildrenPickable, getChildrenReference, getClientProperties, getClientPropertyKeysEnumeration, getDoubleAttribute, getFullBounds, getFullBoundsInvalid, getFullBoundsReference, getGlobalBounds, getGlobalFullBounds, getGlobalRotation, getGlobalScale, getGlobalToLocalTransform, getGlobalTranslation, getHeight, getInputEventListeners, getIntegerAttribute, getInverseTransform, getListenerList, getLocalToGlobalTransform, getName, getOccluded, getOffset, getPaint, getPaintInvalid, getParent, getPickable, getPropertyChangeParentMask, getRoot, getRotation, getScale, getTransform, getTransformReference, getTransparency, getUnionOfChildrenBounds, getVisible, getWidth, getX, getXOffset, getY, getYOffset, globalToLocal, globalToLocal, globalToLocal, indexOfChild, internalUpdateBounds, intersects, invalidateFullBounds, invalidateLayout, invalidatePaint, isAncestorOf, isDescendentOf, isDescendentOfRoot, isOpaque, layoutChildren, lerp, localToGlobal, localToGlobal, localToGlobal, localToParent, localToParent, localToParent, lower, lower, lowerBelow, lowerToBottom, lowerToBottom, offset, paint, paintAfterChildren, parentBoundsChanged, parentToLocal, parentToLocal, parentToLocal, pick, pickAfterChildren, print, print, raise, raise, raiseAbove, raiseToTop, raiseToTop, removeAllChildren, removeChild, removeChild, removeChildren, removeFromParent, removeInputEventListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaintFrom, reparent, replaceWith, resetBounds, rotate, rotateAboutPoint, rotateAboutPoint, rotateInPlace, scale, scaleAboutPoint, scaleAboutPoint, setBounds, setBounds, setBoundsChanged, setChildBoundsInvalid, setChildBoundsVolatile, setChildPaintInvalid, setChildrenPickable, setFullBoundsInvalid, setGlobalRotation, setGlobalScale, setGlobalTranslation, setHeight, setName, setOccluded, setOffset, setOffset, setPaint, setPaintInvalid, setParent, setPickable, setPropertyChangeParentMask, setRotation, setScale, setTransform, setTransparency, setVisible, setWidth, setX, setY, signalBoundsChanged, startResizeBounds, toImage, toImage, toImage, toImage, transformBy, translate, validateFullBounds, validateFullPaint

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VennNode

public VennNode(VennModel<E> model)

Create a new venn node with the specified model.

Parameters:

model - model for this venn node, must not be null

Method Detail

updateLabels

protected void updateLabels()

Description copied from class: AbstractVennNode

Update labels.

Specified by:

updateLabels in class AbstractVennNode<E>

size

public final int size()

Return the size of this venn node.

Returns:

the size of this venn node

getLayout

public final VennLayout getLayout()

Return the layout for this venn node. The layout will not be null.

Returns:

the layout for this venn node

setLayout

public final void setLayout(VennLayout layout)

Set the layout for this venn node to layout.

This is a bound property.

Parameters:

layout - layout for this venn node, must not be null

getModel

public final VennModel<E> getModel()

Return the model for this venn node. The model will not be null.

Returns:

the model for this venn node

getPath

public final org.piccolo2d.nodes.PPath getPath(int index)

Return the path node for the set at the specified index.

Parameters:

index - index

Returns:

the path node for the set at the specified index

Throws:

IndexOutOfBoundsException - if index is out of bounds

getLabelText

public final String getLabelText(int index)

Return the label text for the set at the specified index. Defaults to DEFAULT_LABEL_TEXT.get(index).

Parameters:

index - index

Returns:

the label text for the set at the specified index

Throws:

IndexOutOfBoundsException - if index is out of bounds

setLabelText

public final void setLabelText(int index,
                String labelText)

Set the label text for the set at the specified index to labelText.

This is a bound property.

Parameters:

index - index

labelText - label text for the set at the specified index

Throws:

IndexOutOfBoundsException - if index is out of bounds

getLabel

public final org.piccolo2d.nodes.PText getLabel(int index)

Return the label for the set at the specified index. The text for the returned PText should not be changed, as the text is synchronized to the venn model backing this venn diagram. Use methods setLabelText(int, String) and AbstractVennNode.setDisplaySizes(boolean) to set the label text and whether to display sizes respectively.

Returns:

the label for the set at the specified index

getArea

public final org.piccolo2d.nodes.PArea getArea(int index,
                                int... additional)

Return the area node for the intersecting area defined by the specified indices.

Parameters:

index - first index

additional - variable number of additional indices, if any

Returns:

the area node for the intersecting area defined by the specified indices

Throws:

IndexOutOfBoundsException - if index or any of additional are out of bounds, or if too many indices are specified

getAreaLabelText

public final String getAreaLabelText(int index,
                      int... additional)

Return the area label text for the intersecting area defined by the specified indices.

Parameters:

index - first index

additional - variable number of additional indices, if any

Returns:

the area label text for the intersecting area defined by the specified indices

Throws:

IndexOutOfBoundsException - if index or any of additional are out of bounds, or if too many indices are specified

getSizeLabel

public final org.piccolo2d.nodes.PText getSizeLabel(int index,
                                     int... additional)

Return the size label for the intersecting area defined by the specified indices.

Parameters:

index - first index

additional - variable number of additional indices, if any

Returns:

the size label for the intersecting area defined by the specified indices

Throws:

IndexOutOfBoundsException - if index or any of additional are out of bounds, or if too many indices are specified

labels

public Iterable<org.piccolo2d.nodes.PText> labels()

Description copied from class: AbstractVennNode

Return the labels for this venn diagram node.

Specified by:

labels in class AbstractVennNode<E>

Returns:

the labels for this venn diagram node

nodes

public Iterable<org.piccolo2d.PNode> nodes()

Description copied from class: AbstractVennNode

Return the nodes for this venn diagram node.

Specified by:

nodes in class AbstractVennNode<E>

Returns:

the nodes for this venn diagram node

labelForNode

public org.piccolo2d.nodes.PText labelForNode(org.piccolo2d.PNode node)

Description copied from class: AbstractVennNode

Return the label for the specified node, if any.

Specified by:

labelForNode in class AbstractVennNode<E>

Parameters:

node - node

Returns:

the label for the specified node, or null if no such label exists

labelTextForNode

public String labelTextForNode(org.piccolo2d.PNode node)

Description copied from class: AbstractVennNode

Return the label text for the specified node, if any.

Specified by:

labelTextForNode in class AbstractVennNode<E>

Parameters:

node - node

Returns:

the label text for the specified node, or null if no such label exists

sizeLabels

public Iterable<org.piccolo2d.nodes.PText> sizeLabels()

Description copied from class: AbstractVennNode

Return the size labels for this venn diagram node.

Specified by:

sizeLabels in class AbstractVennNode<E>

Returns:

the size labels for this venn diagram node

viewForNode

public Set<E> viewForNode(org.piccolo2d.PNode node)

Description copied from class: AbstractVennNode

Return the view for the specified node, if any.

Specified by:

viewForNode in class AbstractVennNode<E>

Parameters:

node - node

Returns:

the view for the specified node, or null if no such view exists

buildAreaLabel

protected final String buildAreaLabel(int index,
                    int... additional)

Build and return area label text.

Parameters:

index - index

additional - variable number of additional indices

Throws:

IndexOutOfBoundsException - if index or any of additional are out of bounds, or if too many indices are specified

range

static com.google.common.collect.ImmutableSet<Integer> range(int n)

Return an immutable set of the integers between 0 and n, exclusive.

Parameters:

n - n

Returns:

an immutable set of integers between 0 and n, exclusive

first

static int first(org.dishevelled.bitset.ImmutableBitSet bitSet)

Return the first index set to true in the specified bit set.

Parameters:

bitSet - bit set

Returns:

the first index set to true in the specified bit set or -1 if no bits in the specified bit set are set to true

additional

static int[] additional(org.dishevelled.bitset.ImmutableBitSet bitSet)

Return the additional indices set to true in the specified bit set.

Parameters:

bitSet - bit set

Returns:

the additional indices set to true in the specified bit set or an empty int[] if only zero or one bits are set to true the specified bit set

first

static int first(Set<Integer> values)

Return the first int value in the specified set of values.

Parameters:

values - set of values

Returns:

the first int value int the specified set of values

additional

static int[] additional(Set<Integer> values)

Return the additional int values in the specified set of values.

Parameters:

values - set of values

Returns:

the additional it values in the specified set of values

toImmutableBitSet

static org.dishevelled.bitset.ImmutableBitSet toImmutableBitSet(int index,
                                                       int... additional)

Create and return a new immutable bit set with the specified bits set to true.

Parameters:

index - first index to set to true

additional - variable number of additional indices to set to true, if any

Returns:

a new immutable bit set with the specified bits set to true

toImmutableBitSet

static org.dishevelled.bitset.ImmutableBitSet toImmutableBitSet(Set<Integer> indices)

Create and return a new immutable bit set with the specified bits set to true.

Parameters:

indices - set of indices to set to true, must not be null and must not be empty

Returns:

a new immutable bit set with the specified bits set to true