public class ContainerNodeBuilder
extends java.lang.Object
Constructor and Description |
---|
ContainerNodeBuilder()
Initializes a new instance of the ContainerNodeBuilder class.
|
ContainerNodeBuilder(ContainerNode instance)
Initializes a new instance of the ContainerNodeBuilder class.
|
Modifier and Type | Method and Description |
---|---|
ContainerNodeBuilder |
allowAddChildren(boolean value)
Sets a value indicating whether child nodes can be added interactively to this container.
|
ContainerNodeBuilder |
allowIncomingLinks(boolean value)
Sets a value indicating whether users are allowed to draw links to this node.
|
ContainerNodeBuilder |
allowOutgoingLinks(boolean value)
Sets a value indicating whether users are allowed to draw links from this node.
|
ContainerNodeBuilder |
allowRemoveChildren(boolean value)
Sets a value indicating whether child nodes can be removed interactively from this container.
|
ContainerNodeBuilder |
anchorPattern(AnchorPattern value)
Sets the anchor points to which link end points are aligned when
links connect to this node.
|
ContainerNodeBuilder |
autoDeleteChildren(boolean value)
Sets whether deleting this container should
also remove its child items from the diagram.
|
ContainerNodeBuilder |
autoGrow(boolean value)
Sets a value indicating whether the container should grow in size when nodes are added to it.
|
ContainerNodeBuilder |
autoShrink(boolean value)
Sets a value indicating whether the container should
shrink in size when nodes are removed from it.
|
ContainerNodeBuilder |
brush(Brush value)
Sets the brush used to fill the item's interior.
|
ContainerNodeBuilder |
brush(java.awt.Color color) |
ContainerNodeBuilder |
brush(java.awt.Color color1,
java.awt.Color color2,
int angle) |
ContainerNodeBuilder |
caption(java.lang.String value)
Sets the container's caption text.
|
ContainerNodeBuilder |
captionBackBrush(Brush value)
Sets the brush used to paint the caption area of this container.
|
ContainerNodeBuilder |
captionBackBrush(java.awt.Color color) |
ContainerNodeBuilder |
captionBackBrush(java.awt.Color color1,
java.awt.Color color2,
int angle) |
ContainerNodeBuilder |
captionBrush(Brush value)
Sets the brush used to draw the container's caption text.
|
ContainerNodeBuilder |
captionBrush(java.awt.Color color) |
ContainerNodeBuilder |
captionBrush(java.awt.Color color1,
java.awt.Color color2,
int angle) |
ContainerNodeBuilder |
captionFormat(TextFormat value)
Sets the caption alignment and format.
|
ContainerNodeBuilder |
captionHeight(float value)
Sets the height of the container's caption area.
|
ContainerNodeBuilder |
clipChildren(boolean value)
Sets a value indicating whether child items should be clipped by container boundaries.
|
ContainerNodeBuilder |
constraints(NodeConstraints value)
Sets constraints to the node size and movement direction.
|
ContainerNodeBuilder |
cornerRadius(float value)
Sets the radius of node's corner arcs when its Shape is set to RoundedRectangle.
|
ContainerNode |
create()
Creates a new object with the attributes accumulated by this builder.
|
ContainerNodeBuilder |
enabledHandles(java.util.EnumSet<NodeHandleType> value)
Sets a combination of
NodeHandleType members identifying which manipulation
handles are enabled for a node. |
ContainerNodeBuilder |
expandable(boolean value)
Sets a value indicating whether users are allowed to expand or collapse
the tree branch that starts from this node.
|
ContainerNodeBuilder |
expanded(boolean value)
Expands or collapses the tree branch that starts from a node.
|
ContainerNodeBuilder |
foldable(boolean value)
Sets a value indicating whether the user is allowed
to fold this container.
|
ContainerNodeBuilder |
folded(boolean value)
Sets a value indicating whether this container is folded.
|
ContainerNodeBuilder |
foldedSize(java.awt.geom.Dimension2D value)
Sets the size of the container when folded.
|
ContainerNodeBuilder |
foldIconSize(java.lang.Float value)
Sets the size of the fold / unfold icon.
|
ContainerNodeBuilder |
font(java.awt.Font value)
Sets the font used to draw the text of an item.
|
ContainerNodeBuilder |
font(java.lang.String fontName,
float fontSize) |
ContainerNode |
get()
Returns an existing object passed for initialization to this builder.
|
ContainerNodeBuilder |
handlesStyle(HandlesStyle value)
Sets the style of the box selection handles.
|
ContainerNodeBuilder |
highlightPen(Pen value)
Sets the
Pen used to draw the container frame lines
when an item is dragged over the container. |
ContainerNodeBuilder |
hyperLink(java.lang.String value)
Sets the hyperlink associated with an item.
|
ContainerNodeBuilder |
id(java.lang.Object value)
Assigns user-defined identifier to this item.
|
ContainerNodeBuilder |
ignoreLayout(boolean value)
Sets a value indicating whether an item should be ignored
by the automatic layout algorithms.
|
ContainerNodeBuilder |
layerIndex(int value)
Sets the zero-based index of the layer this item is associated
with, or -1, if the item is not associated with any layer.
|
ContainerNodeBuilder |
locked(boolean value)
Sets a value indicating whether users are allowed to modify an item.
|
ContainerNodeBuilder |
margin(float value)
Sets how much space should be left between
contained nodes and the container borders.
|
ContainerNodeBuilder |
minimumSize(java.awt.geom.Dimension2D value)
Sets the minimum size of the container.
|
ContainerNodeBuilder |
obstacle(boolean value)
Sets a value indicating whether the link routing algorithm
should consider this node an obstacle.
|
ContainerNodeBuilder |
pen(Pen value)
Sets the pen used to draw the item frame lines.
|
ContainerNodeBuilder |
printable(boolean value)
Sets a value indicating whether an item will be printed.
|
ContainerNodeBuilder |
rotationAngle(float value)
Sets the rotation angle of a node.
|
ContainerNodeBuilder |
scrollable(boolean value)
Sets a value indicating whether users are
allowed to scroll the contents of this container.
|
ContainerNodeBuilder |
scrollX(float value)
Sets the container's horizontal scroll position.
|
ContainerNodeBuilder |
scrollY(float value)
Sets the container's vertical scroll position.
|
ContainerNodeBuilder |
selected(boolean value)
Selects or deselects an item.
|
ContainerNodeBuilder |
shadowBrush(Brush value)
Sets the color of the item's shadow.
|
ContainerNodeBuilder |
shadowBrush(java.awt.Color color) |
ContainerNodeBuilder |
shadowBrush(java.awt.Color color1,
java.awt.Color color2,
int angle) |
ContainerNodeBuilder |
shadowOffsetX(float value)
Sets the horizontal distance between a shadow and the item that casts it.
|
ContainerNodeBuilder |
shadowOffsetY(float value)
Sets the vertical distance between a shadow and the item that casts it.
|
ContainerNodeBuilder |
shape(SimpleShape value)
Sets the shape of this container.
|
ContainerNodeBuilder |
style(DiagramItemStyle value)
Sets the style associated with the item.
|
ContainerNodeBuilder |
tag(java.lang.Object value)
Assigns user-defined data to an item.
|
ContainerNodeBuilder |
textBrush(Brush value)
Sets the brush used to paint texts inside the item.
|
ContainerNodeBuilder |
textBrush(java.awt.Color color) |
ContainerNodeBuilder |
textBrush(java.awt.Color color1,
java.awt.Color color2,
int angle) |
ContainerNodeBuilder |
textPadding(Thickness value)
Sets the spacing between the item boundaries and its text.
|
ContainerNodeBuilder |
toolTip(java.lang.String value)
Sets the tooltip text that should be displayed when the mouse
pointer rests over an item.
|
ContainerNodeBuilder |
visible(boolean value)
Sets a value indicating whether the container is visible.
|
ContainerNodeBuilder |
weight(float value)
Sets a weight value used in layout and path-finding algorithms.
|
ContainerNodeBuilder |
zIndex(int value)
Sets the position of an item within the diagram's Z order.
|
public ContainerNodeBuilder()
public ContainerNodeBuilder(ContainerNode instance)
public ContainerNodeBuilder zIndex(int value)
value
- An integer value specifying the position of the item
within the diagram Z order.public ContainerNodeBuilder allowAddChildren(boolean value)
value
- true
to allow adding child nodes, otherwise false
. The default value is true
.public ContainerNodeBuilder allowIncomingLinks(boolean value)
value
- true
if incoming links can be drawn to this node,
otherwise false
.public ContainerNodeBuilder allowOutgoingLinks(boolean value)
value
- true
if outgoing links can be drawn from
this node, otherwise false
.public ContainerNodeBuilder allowRemoveChildren(boolean value)
value
- true
to allow removing child nodes, otherwise false
. The default value is true
.public ContainerNodeBuilder anchorPattern(AnchorPattern value)
value
- An AnchorPattern
object that defines
the anchor points for this node.public ContainerNodeBuilder autoDeleteChildren(boolean value)
value
- true to automatically delete child items, or false otherwise.public ContainerNodeBuilder autoGrow(boolean value)
value
- true to grow container's size automatically, or false otherwise.public ContainerNodeBuilder autoShrink(boolean value)
public ContainerNodeBuilder brush(Brush value)
value
- A Brush
-derived object representing the item's brush.public ContainerNodeBuilder brush(java.awt.Color color)
public ContainerNodeBuilder brush(java.awt.Color color1, java.awt.Color color2, int angle)
public ContainerNodeBuilder caption(java.lang.String value)
public ContainerNodeBuilder captionBackBrush(Brush value)
value
- A Brush instance that should be used to paint caption area.public ContainerNodeBuilder captionBackBrush(java.awt.Color color)
public ContainerNodeBuilder captionBackBrush(java.awt.Color color1, java.awt.Color color2, int angle)
public ContainerNodeBuilder captionBrush(Brush value)
public ContainerNodeBuilder captionBrush(java.awt.Color color)
public ContainerNodeBuilder captionBrush(java.awt.Color color1, java.awt.Color color2, int angle)
public ContainerNodeBuilder captionFormat(TextFormat value)
public ContainerNodeBuilder captionHeight(float value)
public ContainerNodeBuilder clipChildren(boolean value)
value
- true
to clip child items, otherwise false
. The default value is true
.public ContainerNodeBuilder constraints(NodeConstraints value)
value
- A NodeConstraints
object.public ContainerNodeBuilder cornerRadius(float value)
value
- The radius of node's corner arcs.public ContainerNodeBuilder enabledHandles(java.util.EnumSet<NodeHandleType> value)
NodeHandleType
members identifying which manipulation
handles are enabled for a node. This effectively controls what kind of
modifications users are allowed to perform on this node.value
- A set of NodeHandleType
members.public ContainerNodeBuilder expandable(boolean value)
value
- true
if the tree branch that starts from this node
can be expanded or collapsed by users, otherwise false
.public ContainerNodeBuilder expanded(boolean value)
value
- true
if the tree branch that starts from
this node should be expanded, otherwise false
.public ContainerNodeBuilder foldIconSize(java.lang.Float value)
value
- A Float value specifying the size of fold / unfold icon.public ContainerNodeBuilder foldable(boolean value)
public ContainerNodeBuilder folded(boolean value)
public ContainerNodeBuilder foldedSize(java.awt.geom.Dimension2D value)
public ContainerNodeBuilder font(java.awt.Font value)
value
- A Font
object representing the font
used to draw this item's text.public ContainerNodeBuilder font(java.lang.String fontName, float fontSize)
public ContainerNodeBuilder handlesStyle(HandlesStyle value)
value
- A member of the HandlesStyle
enumeration.public ContainerNodeBuilder highlightPen(Pen value)
Pen
used to draw the container frame lines
when an item is dragged over the container.public ContainerNodeBuilder hyperLink(java.lang.String value)
value
- A String
containing the hyperlink.public ContainerNodeBuilder id(java.lang.Object value)
DiagramListener.serializeTag(com.mindfusion.diagramming.SerializeTagEvent)
event.value
- An Object
containing custom data.public ContainerNodeBuilder ignoreLayout(boolean value)
value
- true
if the item should be ignored by
automatic layout algorithms, otherwise false
.public ContainerNodeBuilder layerIndex(int value)
value
- An integer value specifying the layer index.public ContainerNodeBuilder locked(boolean value)
value
- true
if the item should not be modified,
otherwise false
.public ContainerNodeBuilder margin(float value)
public ContainerNodeBuilder minimumSize(java.awt.geom.Dimension2D value)
public ContainerNodeBuilder obstacle(boolean value)
value
- true
if auto-routed links should go around
this node, otherwise false
.public ContainerNodeBuilder pen(Pen value)
value
- A Pen
object representing the item's pen.public ContainerNodeBuilder printable(boolean value)
value
- true
if the item should be drawn
when printing the diagram, otherwise false
.public ContainerNodeBuilder rotationAngle(float value)
value
- A float value specifying the node rotation angle.public ContainerNodeBuilder scrollX(float value)
value
- A float value indicating horizontal scroll offset.public ContainerNodeBuilder scrollY(float value)
value
- A float value indicating vertical scroll offset.public ContainerNodeBuilder scrollable(boolean value)
value
- true if scrolling is allowed, or false otherwise.public ContainerNodeBuilder selected(boolean value)
value
- true
if the item should be selected,
otherwise false
.public ContainerNodeBuilder shadowBrush(Brush value)
value
- A Brush
object representing the brush of the item's shadow.public ContainerNodeBuilder shadowBrush(java.awt.Color color)
public ContainerNodeBuilder shadowBrush(java.awt.Color color1, java.awt.Color color2, int angle)
public ContainerNodeBuilder shadowOffsetX(float value)
value
- A float value representing the horizontal offset of the
item's shadow.public ContainerNodeBuilder shadowOffsetY(float value)
value
- A float value representing the vertical offset of the
item's shadow.public ContainerNodeBuilder shape(SimpleShape value)
value
- A member of the SimpleShape
enumeration.public ContainerNodeBuilder style(DiagramItemStyle value)
public ContainerNodeBuilder tag(java.lang.Object value)
DiagramListener.serializeTag(com.mindfusion.diagramming.SerializeTagEvent)
event.value
- An Object
containing custom data.public ContainerNodeBuilder textBrush(Brush value)
public ContainerNodeBuilder textBrush(java.awt.Color color)
public ContainerNodeBuilder textBrush(java.awt.Color color1, java.awt.Color color2, int angle)
public ContainerNodeBuilder textPadding(Thickness value)
value
- A Thickness
instance specifying the size of the padding space left around the text.public ContainerNodeBuilder toolTip(java.lang.String value)
value
- A String
that contains the tooltip text.public ContainerNodeBuilder visible(boolean value)
public ContainerNodeBuilder weight(float value)
value
- A float value representing the item's weight.public ContainerNode create()
public ContainerNode get()