DroidDiagram Programmer's Guide
Selection Members
Constructors Fields Methods
 


Represents a selection of multiple items. Each Diagram has its own Selection instance, which can be accessed by the getSelection method.

The following tables list the members exposed by the Selection type.

 Public Constructors

  Name Description

Selection

Initializes a new Selection instance.

 Protected Fields

  Name Description

brush

  (Inherited from DiagramItem.)

cycleDetected

  (Inherited from DiagramItem.)

cycleProtect

  (Inherited from DiagramItem.)

modifyDX

  (Inherited from DiagramItem.)

modifyDY

  (Inherited from DiagramItem.)

modifyHandle

  (Inherited from DiagramItem.)

modifying

  (Inherited from DiagramItem.)

pen

  (Inherited from DiagramItem.)

ptEnd

  (Inherited from DiagramItem.)

ptMdfLast

  (Inherited from DiagramItem.)

ptOrg

  (Inherited from DiagramItem.)

ptSavedEnd

  (Inherited from DiagramItem.)

ptSavedOrg

  (Inherited from DiagramItem.)

subordinateGroup

  (Inherited from DiagramItem.)

 Public Methods

  Name Description

addItem

Adds the specified item to the selection.

change

Changes the selection to the specified item. That means that the item gets selected and all other items are unselected.

clear

Removes all items from the selection.

clone

Creates a copy of this item. (Inherited from DiagramItem.)

containsPoint

Overloaded.  

getAllowMultipleSelection

Gets a value indicating whether users are allowed to select multiple items.

getBounds

Gets the smallest rectangle that bounds all selected items.

getBrush

Gets the brush used to fill the item's interior. (Inherited from DiagramItem.)

getEffectiveBrush

Gets the effective brush of the item. (Inherited from DiagramItem.)

getEffectiveFont

Gets the currently effective font of the item. This property returns getFont if it is not null, or a font with the DiagramItemStyle.getFontFamily, DiagramItemStyle.getFontSize, and DiagramItemStyle.getFontStyle properties of the item's style. (Inherited from DiagramItem.)

getEffectivePen

Gets the effective pen of the item. (Inherited from DiagramItem.)

getEffectiveShadowBrush

Creates a Brush object representing the currently effective shadow brush of the item. This method returns a system brush corresponding to the item's getShadowBrush if the item's getShadowBrush is not null, or a system brush corresponding to the DiagramItemStyle.getShadowBrush property of the item's style. (Inherited from DiagramItem.)

getEffectiveTextBrush

Gets the effective text brush of the item. (Inherited from DiagramItem.)

getFont

Gets the font used to draw the text of an item. (Inherited from DiagramItem.)

getHandlesStyle

Gets a value indicating how multiple selection is drawn on the screen.

getHyperLink

Gets the hyperlink associated with an item. (Inherited from DiagramItem.)

getId

Gets user-defined identifier associated with this item. (Inherited from DiagramItem.)

getIgnoreLayout

Gets a value indicating whether an item should be ignored by the automatic layout algorithms. (Inherited from DiagramItem.)

getItems

Gets a list of all selected items.

getLayerIndex

Gets the zero-based index of the layer this item is associated with, or -1, if the item is not associated with any layer. (Inherited from DiagramItem.)

getLayoutTraits

Returns a hashtable containing properties specific to layout algorithms. (Inherited from DiagramItem.)

getLinks

Gets a list of all selected links.

getLocked

Gets a value indicating whether users are allowed to modify an item. (Inherited from DiagramItem.)

getMasterGroup

Gets the hierarchical group in which this item is a subordinate. (Inherited from DiagramItem.)

getNodes

Gets a list of all selected boxes.

getOffsetUnconnectedLinks

Specifies whether to translate all points of selected unconnected links when moving multiple selection.

getParent

Gets the diagram that contains this item. (Inherited from DiagramItem.)

getPen

Gets the pen used to draw the item frame lines. (Inherited from DiagramItem.)

getPrintable

Gets a value indicating whether an item will be printed. (Inherited from DiagramItem.)

getRuntimeIndex

For internal use. (Inherited from DiagramItem.)

getSelected

Gets a value indicating whether this item is selected. (Inherited from DiagramItem.)

getSetsDirtyFlag

Gets a value indicating whether the diagram's Dirty flag should be set when selection changes.

getShadowBrush

Gets the brush used to paint the item's shadow. (Inherited from DiagramItem.)

getShadowOffsetX

Gets the horizontal distance between a shadow and the item that casts it. (Inherited from DiagramItem.)

getShadowOffsetY

Gets the vertical distance between a shadow and the item that casts it. (Inherited from DiagramItem.)

getStyle

Gets the style associated with the item. (Inherited from DiagramItem.)

getSubordinateGroup

Gets the group of subordinated items attached to this one. (Inherited from DiagramItem.)

getTag

Gets user-defined data assigned to an item. (Inherited from DiagramItem.)

getTextBrush

Gets the brush used to paint texts inside the item. (Inherited from DiagramItem.)

getTextPadding

Gets the spacing between the item boundaries and its text. (Inherited from DiagramItem.)

getToolTip

Gets the tooltip text displayed when the pointer rests over this item. (Inherited from DiagramItem.)

getVisible

Gets a value indicating whether an item is visible. (Inherited from DiagramItem.)

getWeight

Gets a weight value used in layout and path-finding algorithms. (Inherited from DiagramItem.)

getZIndex

Gets the position of an item within the diagram's Z-order. (Inherited from DiagramItem.)

hasSubordinates

Checks whether there are any nodes attached to this item. (Inherited from DiagramItem.)

hitTest

Returns the diagram item that contains the specified point. (Inherited from DiagramItem.)

hitTestHandle

DiagramItem.hitTestHandle override.

itemInSelection

Determines whether the specified item is selected.

query

Returns the items that can be reached from this item by following the path specified in the given query expression. (Inherited from DiagramItem.)

readExternal

Implements Externalizable.

removeItem

Removes the specified item from the selection.

setAllowMultipleSelection

Sets a value indicating whether users are allowed to select multiple items.

setBrush

Sets the brush used to fill the item's interior. (Inherited from DiagramItem.)

setFont

Sets the font used to draw the text of an item. (Inherited from DiagramItem.)

setHandlesStyle

Sets a value indicating how multiple selection should be drawn on the screen.

setHyperLink

Sets the hyperlink associated with an item. (Inherited from DiagramItem.)

setId

Assigns user-defined identifier to this item. (Inherited from DiagramItem.)

setIgnoreLayout

Sets a value indicating whether an item should be ignored by the automatic layout algorithms. (Inherited from DiagramItem.)

setLayerIndex

Sets the zero-based index of the layer this item is associated with, or -1, if the item is not associated with any layer. (Inherited from DiagramItem.)

setLocked

Sets a value indicating whether users are allowed to modify an item. (Inherited from DiagramItem.)

setOffsetUnconnectedLinks

Specifies whether to translate all points of selected unconnected links when moving multiple selection.

setPen

Sets the pen used to draw the item frame lines. (Inherited from DiagramItem.)

setPrintable

Sets a value indicating whether an item will be printed. (Inherited from DiagramItem.)

setSelected

Selects or deselects an item. (Inherited from DiagramItem.)

setSetsDirtyFlag

Sets a value indicating whether the diagram's Dirty flag should be set when selection changes.

setShadowBrush

Sets the brush used to paint the item's shadow. (Inherited from DiagramItem.)

setShadowOffsetX

Sets the horizontal distance between a shadow and the item that casts it. (Inherited from DiagramItem.)

setShadowOffsetY

Sets the vertical distance between a shadow and the item that casts it. (Inherited from DiagramItem.)

setStyle

Sets the style associated with the item. (Inherited from DiagramItem.)

setTag

Assigns user-defined data to an item. If the tag object is serializable, it will be automatically saved when serializing the diagram into binary format. When serializing to XML, you can save the tag by handling the DiagramListener.serializeTag event. (Inherited from DiagramItem.)

setTextBrush

Sets the brush used to paint texts inside the item. (Inherited from DiagramItem.)

setTextPadding

Sets the spacing between the item boundaries and its text. (Inherited from DiagramItem.)

setToolTip

Sets the tooltip text that should be displayed when the pointer rests over this item. (Inherited from DiagramItem.)

setVisible

Sets a value indicating whether an item is visible. (Inherited from DiagramItem.)

setWeight

Sets a weight value used in layout and path-finding algorithms. (Inherited from DiagramItem.)

setZIndex

Sets the position of an item within the diagram's Z-order. (Inherited from DiagramItem.)

size

Returns the number of selected items.

toggle

Toggles the selection state of the specified item.

writeExternal

Implements Externalizable.

zBottom

Moves an item to the bottom of the Z order. (Inherited from DiagramItem.)

zLevelDown

Moves an item down in the Z order. (Inherited from DiagramItem.)

zLevelUp

Moves an item up in the Z order. (Inherited from DiagramItem.)

zTop

Moves an item to the top of the Z order. (Inherited from DiagramItem.)

 Protected Methods

  Name Description

allowCreate

 

allowModify

 

cancelModify

 

completeCreate

 

completeModify

 

createProperties

Creates an item property set corresponding to the type of this diagram item. This method is invoked by the undo/redo subsystem when creating a ChangeItemCmd instance. (Inherited from DiagramItem.)

createState

Creates an item state corresponding to the type of this diagram item. (Inherited from DiagramItem.)

draw

 

drawShadow

 

getMeasureUnit

  (Inherited from DiagramItem.)

getRepaintRect

DiagramItem.getRepaintRect override.

getValue

Gets the effective value of the style property with the specified name. (Inherited from DiagramItem.)

loadFromXml

Loads the item content from an XML element. (Inherited from DiagramItem.)

onAdd

Called when an item is added to a Diagram, either by the user, programmatically or by undo / redo. (Inherited from DiagramItem.)

onChangeFont

  (Inherited from DiagramItem.)

onChangeTextPadding

  (Inherited from DiagramItem.)

onChildModified

Called when a group child node has been modified. Override this method if you need to know when a node from the SubordinateGroup is modified. (Inherited from DiagramItem.)

onClick

Invoked when the user clicks this item. (Inherited from DiagramItem.)

onDoubleClick

Invoked when the user double-clicks this item. (Inherited from DiagramItem.)

onLoad

Called when this item is loaded from a file. (Inherited from DiagramItem.)

onMeasureUnitChanged

Called when the diagram's MeasureUnit changes. (Inherited from DiagramItem.)

onRemove

Called when an item is removed from a Diagram, either by the user, programmatically or by undo / redo. (Inherited from DiagramItem.)

onStyleChanged

Invoked when the associated style or theme have changed. (Inherited from DiagramItem.)

onStyleFontChanged

Invoked when font property values of an associated style change. (Inherited from DiagramItem.)

putSelected

  (Inherited from DiagramItem.)

repaint

Overloaded.   (Inherited from DiagramItem.)

restoreProperties

Restores the properties of this diagram item. This method is invoked by the undo/redo subsystem when undoing or redoing a ChangeItemCmd instance. (Inherited from DiagramItem.)

restoreState

Restores the state of this diagram item. (Inherited from DiagramItem.)

saveProperties

Saves the properties of this diagram item. This method is invoked by the undo/redo subsystem when saving a ChangeItemCmd instance. (Inherited from DiagramItem.)

saveState

Saves the state of this diagram item. (Inherited from DiagramItem.)

saveToXml

Saves the item content into an XML element. (Inherited from DiagramItem.)

setDiagramDirty

Marks the diagram as changed. (Inherited from DiagramItem.)

shouldRender

Determines whether the item is rendered in the current context. (Inherited from DiagramItem.)

startCreate

 

startModify

DiagramItem.startModify override.

updateCreate

 

updateModify

 

 See Also

Selection Class
com.mindfusion.diagramming Namespace