| Package | com.yworks.graph.model |
| Class | public class StripeSelection |
| Inheritance | StripeSelection  flash.events.EventDispatcher |
| Implements | IStripeSelection |
IStripeSelection interface.
| Property | Defined By | ||
|---|---|---|---|
| count : uint [read-only]
Returns the number of selected items. | StripeSelection | ||
| crossTableSelectionAllowed : Boolean
Whether to allow the selection to span multiple table instances. | StripeSelection | ||
| mixedSelectionAllowed : Boolean
Whether to allow mixed row/column selections. | StripeSelection | ||
| selectedColumns : ISelectionModel [read-only]
An ISelectionModel of the selected columns. | StripeSelection | ||
| selectedObjects : Iterable [read-only]
Gets an iterable that enumerates all currently selected items. | StripeSelection | ||
| selectedRows : ISelectionModel [read-only]
An ISelectionModel of the selected rows. | StripeSelection | ||
| selectedStripes : ICollectionModel [read-only]
An ICollectionModel of all selected items. | StripeSelection | ||
| Method | Defined By | ||
|---|---|---|---|
Default constructor that creates empty selection models. | StripeSelection | ||
clear():void
Clears the selection. | StripeSelection | ||
isSelected(item:IModelItem):Boolean
Determines whether an item is currently selected. | StripeSelection | ||
Returns an iterator over a set of elements. | StripeSelection | ||
setSelected(item:IModelItem, selected:Boolean):void
Sets the selection state of an item. | StripeSelection | ||
| Method | Defined By | ||
|---|---|---|---|
onItemDeselected(event:CollectionEvent):void
Raises the SelectionEvent.DESELECT event for each newly deselected item. | StripeSelection | ||
onItemSelected(event:CollectionEvent):void
Raises the SelectionEvent.SELECT event for each newly selected item. | StripeSelection | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the collection has changed. | StripeSelection | |||
| Dispatched when an item changed its selection state from selected to unselected. | StripeSelection | |||
| Dispatched when an item changed its selection state from unselected to selected. | StripeSelection | |||
| count | property |
count:uint [read-only] Returns the number of selected items.
public function get count():uint| crossTableSelectionAllowed | property |
crossTableSelectionAllowed:BooleanWhether to allow the selection to span multiple table instances.
The default value is true.
public function get crossTableSelectionAllowed():Boolean public function set crossTableSelectionAllowed(value:Boolean):void| graph | property |
graph:IGraph yworks_internal function get graph():IGraph yworks_internal function set graph(value:IGraph):void| mixedSelectionAllowed | property |
mixedSelectionAllowed:BooleanWhether to allow mixed row/column selections.
The default value is false.
public function get mixedSelectionAllowed():Boolean public function set mixedSelectionAllowed(value:Boolean):void| selectedColumns | property |
selectedColumns:ISelectionModel [read-only]
An ISelectionModel of the selected columns.
This is the column part of the selection that this instance is a composite of.
public function get selectedColumns():ISelectionModel| selectedObjects | property |
selectedObjects:Iterable [read-only] Gets an iterable that enumerates all currently selected items.
public function get selectedObjects():Iterable| selectedRows | property |
selectedRows:ISelectionModel [read-only]
An ISelectionModel of the selected rows.
This is the row part of the selection that this instance is a composite of.
public function get selectedRows():ISelectionModel| selectedStripes | property |
selectedStripes:ICollectionModel [read-only]
An ICollectionModel of all selected items.
public function get selectedStripes():ICollectionModel| StripeSelection | () | Constructor |
public function StripeSelection()Default constructor that creates empty selection models.
| clear | () | method |
public function clear():voidClears the selection.
| isSelected | () | method |
public function isSelected(item:IModelItem):BooleanDetermines whether an item is currently selected.
Parameters
item:IModelItem — The item to check.
|
Boolean — Whether the item is currently selected.
|
| iterator | () | method |
public function iterator():IteratorReturns an iterator over a set of elements.
ReturnsIterator — an Iterator.
|
| onItemDeselected | () | method |
protected function onItemDeselected(event:CollectionEvent):void
Raises the SelectionEvent.DESELECT event for each newly deselected item.
Parameters
event:CollectionEvent — A collection event which contains an array of the newly deselected items
in its items property.
|
| onItemSelected | () | method |
protected function onItemSelected(event:CollectionEvent):void
Raises the SelectionEvent.SELECT event for each newly selected item.
Parameters
event:CollectionEvent — A collection event which contains an array of the newly selected items
in its items property.
|
| setSelected | () | method |
public function setSelected(item:IModelItem, selected:Boolean):voidSets the selection state of an item.
Parameters
item:IModelItem — The object to set the selection state for.
| |
selected:Boolean — Whether to select the object.
|
| collectionChange | Event |
mx.events.CollectionEventmx.events.CollectionEvent.COLLECTION_CHANGEDispatched when the collection has changed.
| deselect | Event |
com.yworks.graph.model.SelectionEventcom.yworks.graph.model.SelectionEvent.DESELECTDispatched when an item changed its selection state from selected to unselected.
| select | Event |
com.yworks.graph.model.SelectionEventcom.yworks.graph.model.SelectionEvent.SELECTDispatched when an item changed its selection state from unselected to selected.