| Package | com.yworks.graph.model |
| Interface | public interface ITable extends ILookup, flash.events.IEventDispatcher |
| Implementors | Table |
| Property | Defined By | ||
|---|---|---|---|
| columnDefaults : IStripeDefaults
The defaults for columns. | ITable | ||
| insets : IRectangle
The insets for this table. | ITable | ||
| layout : IRectangle [read-only]
The relative layout of the table. | ITable | ||
| relativeLocation : IPoint
The relative location of the upper left corner of the table. | ITable | ||
| rootColumn : IColumn [read-only]
The virtual root of the column hierarchy. | ITable | ||
| rootRow : IRow [read-only]
The virtual root of the row hierarchy. | ITable | ||
| rowDefaults : IStripeDefaults
The defaults for rows. | ITable | ||
| Method | Defined By | ||
|---|---|---|---|
addLabel(item:IStripe, text:String, labelModelParameter:ILabelModelParameter = null, style:ILabelStyle = null, preferredSize:ISize = null, tag:Object = null):ILabel
Add a label to the given item using the text as the initial label text and
label model parameter and style. | ITable | ||
createColumn(owner:IColumn = null, index:int = -1, width:Number = -1, minWidth:Number = -1, insets:IRectangle = null, style:INodeStyle = null, tag:Object = null):IColumn
Create a new column as the indexth child of owner
with the given parameters. | ITable | ||
createRow(owner:IRow = null, index:int = -1, height:Number = -1, minHeight:Number = -1, insets:IRectangle = null, style:INodeStyle = null, tag:Object = null):IRow
Create a new row as the indexth child of owner
with the given parameters. | ITable | ||
 | lookup(type:Class):Object
Returns an instance that implements the given type or null. | ILookup | |
Removes the given stripe from its parent container. | ITable | ||
removeLabel(label:ILabel):void
Removes the given label from its owner. | ITable | ||
Sets the insets of the given stripe. | ITable | ||
Sets the label model parameter for the given label. | ITable | ||
Assigns the given style instance by reference to the label. | ITable | ||
setLabelText(label:ILabel, text:String):void
Sets the label text of the given label. | ITable | ||
setMinimumSize(stripe:IStripe, newSize:Number):void
Sets the minimum size of the given stripe. | ITable | ||
Sets owner as new parent of column. | ITable | ||
Sets owner as new parent of row. | ITable | ||
setPreferredSize(label:ILabel, width:Number, height:Number):void
Sets the preferred size of the label. | ITable | ||
Sets the actual size of the given stripe. | ITable | ||
Sets the style of the given stripe. | ITable | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when a new label has been added to a stripe (column or row). | ITable | |||
| Dispatched when the label of a stripe (column or row) has been changed. | ITable | |||
| Dispatched when a label has been removed from its stripe (column or row). | ITable | |||
| Dispatched when a stripe (column or row) has been changed. | ITable | |||
| Dispatched when a new stripe (column or row) is created. | ITable | |||
| Dispatched when a stripe (column or row) is removed from its parent. | ITable | |||
| columnDefaults | property |
Hide Inherited Public Methods
Show Inherited Public MethodscolumnDefaults:IStripeDefaultsThe defaults for columns.
The settings that are obtained from the instance influence newly created elements only. Setting different defaults afterwards does not influence existing elements.
public function get columnDefaults():IStripeDefaults public function set columnDefaults(value:IStripeDefaults):void| insets | property |
insets:IRectangleThe insets for this table.
These insets are applied in addition to any implicit insets provided by the child stripes.
The default value is (0,0,0,0).
public function get insets():IRectangle public function set insets(value:IRectangle):void| layout | property |
layout:IRectangle [read-only] The relative layout of the table.
The upper left corner of the layout always coincides with
relativeLocation.
public function get layout():IRectangle| relativeLocation | property |
relativeLocation:IPointThe relative location of the upper left corner of the table.
The actual interpretation of this value depends on the context. If the table is bound to a node, this location is usually interpreted relative to the upper left corner of the node layout.
public function get relativeLocation():IPoint public function set relativeLocation(value:IPoint):void| rootColumn | property |
rootColumn:IColumn [read-only] The virtual root of the column hierarchy.
This row should not be queried except for the IColumn.owner
and the associated IStripe.table.
public function get rootColumn():IColumnSee also
| rootRow | property |
rootRow:IRow [read-only] The virtual root of the row hierarchy.
This row should not be queried except for the IRow.owner
and the associated IStripe.table.
public function get rootRow():IRowSee also
| rowDefaults | property |
rowDefaults:IStripeDefaultsThe defaults for rows.
The settings that are obtained from the instance influence newly created elements only. Setting different defaults afterwards does not influence existing elements.
public function get rowDefaults():IStripeDefaults public function set rowDefaults(value:IStripeDefaults):void| addLabel | () | method |
public function addLabel(item:IStripe, text:String, labelModelParameter:ILabelModelParameter = null, style:ILabelStyle = null, preferredSize:ISize = null, tag:Object = null):ILabelAdd a label to the given item using the text as the initial label text and label model parameter and style.
Parameters
item:IStripe — The item to add the label to.
| |
text:String — The initial text of the label.
| |
labelModelParameter:ILabelModelParameter (default = null)columnDefaults
or rowDefaults.
| |
style:ILabelStyle (default = null)columnDefaults
or rowDefaults.
| |
preferredSize:ISize (default = null)ILabel.preferredSize.
If none is provided the parameter will be taken from the columnDefaults
or rowDefaults.
| |
tag:Object (default = null)ITagOwner.tag to assign. May be null.
|
ILabel — The newly created label.
|
See also
| createColumn | () | method |
public function createColumn(owner:IColumn = null, index:int = -1, width:Number = -1, minWidth:Number = -1, insets:IRectangle = null, style:INodeStyle = null, tag:Object = null):IColumn
Create a new column as the indexth child of owner
with the given parameters.
Parameters
owner:IColumn (default = null) | |
index:int (default = -1) | |
width:Number (default = -1)columnDefaults.
| |
minWidth:Number (default = -1)columnDefaults.
| |
insets:IRectangle (default = null)columnDefaults.
| |
style:INodeStyle (default = null)columnDefaults.
| |
tag:Object (default = null) |
IColumn — A new column instance.
|
| createRow | () | method |
public function createRow(owner:IRow = null, index:int = -1, height:Number = -1, minHeight:Number = -1, insets:IRectangle = null, style:INodeStyle = null, tag:Object = null):IRow
Create a new row as the indexth child of owner
with the given parameters.
Parameters
owner:IRow (default = null) | |
index:int (default = -1) | |
height:Number (default = -1)rowDefaults.
| |
minHeight:Number (default = -1)rowDefaults.
| |
insets:IRectangle (default = null)rowDefaults.
| |
style:INodeStyle (default = null)rowDefaults.
| |
tag:Object (default = null)null
|
IRow — A new row instance.
|
| remove | () | method |
public function remove(stripe:IStripe):voidRemoves the given stripe from its parent container.
This method reparents all children of stripe to the parent of the stripe.
Parameters
stripe:IStripe — The stripe to remove.
|
| removeLabel | () | method |
public function removeLabel(label:ILabel):voidRemoves the given label from its owner. This will trigger the corresponding event.
Parameters
label:ILabel — The label to remove.
|
| setInsets | () | method |
public function setInsets(stripe:IStripe, insets:IRectangle):voidSets the insets of the given stripe.
Parameters
stripe:IStripe — The stripe to change.
| |
insets:IRectangle — The new insets of the stripe.
|
| setLabelModelParameter | () | method |
public function setLabelModelParameter(label:ILabel, parameter:ILabelModelParameter):voidSets the label model parameter for the given label.
Parameters
label:ILabel — The label.
| |
parameter:ILabelModelParameter — The new parameter.
|
ArgumentError — If the parameter cannot be used for this label.
|
| setLabelStyle | () | method |
public function setLabelStyle(label:ILabel, style:ILabelStyle):voidAssigns the given style instance by reference to the label. Style instances can be shared.
Parameters
label:ILabel — The label that will be assigned the new style.
| |
style:ILabelStyle — The style instance that will be assigned to the label.
|
See also
| setLabelText | () | method |
public function setLabelText(label:ILabel, text:String):voidSets the label text of the given label.
Parameters
label:ILabel — The label to modify.
| |
text:String — The new text of the label.
|
See also
| setMinimumSize | () | method |
public function setMinimumSize(stripe:IStripe, newSize:Number):voidSets the minimum size of the given stripe.
This method sets the IStripe.minimumSize of stripe.
Parameters
stripe:IStripe — The stripe to change.
| |
newSize:Number — The new minimum size of the stripe.
|
| setParentColumn | () | method |
public function setParentColumn(owner:IColumn, column:IColumn, index:int):void
Sets owner as new parent of column.
The column will be inseted at position index in the child list
of the new parent.
Parameters
owner:IColumn — The new parent.
| |
column:IColumn — The child column.
| |
index:int — The position to insert the child column in the parent's child list.
|
| setParentRow | () | method |
public function setParentRow(owner:IRow, row:IRow, index:int):void
Sets owner as new parent of row.
The row will be inseted at position index in the child list
of the new parent.
Parameters
owner:IRow — The new parent.
| |
row:IRow — The child row.
| |
index:int — The position to insert the child row in the parent's child list.
|
| setPreferredSize | () | method |
public function setPreferredSize(label:ILabel, width:Number, height:Number):voidSets the preferred size of the label.
Parameters
label:ILabel — The label.
| |
width:Number — The new preferred width.
| |
height:Number — The new preferred height.
|
See also
| setSize | () | method |
public function setSize(stripe:IStripe, newSize:Number):voidSets the actual size of the given stripe.
This method sets the IStripe.size of stripe.
Parameters
stripe:IStripe — The stripe to change.
| |
newSize:Number — The new size of the stripe.
|
| setStyle | () | method |
public function setStyle(stripe:IStripe, style:INodeStyle):voidSets the style of the given stripe.
Parameters
stripe:IStripe — The stripe to change.
| |
style:INodeStyle — The new style of the stripe.
|
| labelAdded | Event |
com.yworks.graph.model.StripeEventcom.yworks.graph.model.StripeEvent.LABEL_ADDEDDispatched when a new label has been added to a stripe (column or row).
The label can be retrieved from the event's label property,
its new owner from the stripe property. The parent
property is always null.
| labelChanged | Event |
com.yworks.graph.model.StripeEventcom.yworks.graph.model.StripeEvent.LABEL_CHANGEDDispatched when the label of a stripe (column or row) has been changed.
The label can be retrieved from the event's label property,
its owner from the stripe property. The parent
property is always null.
| labelRemoved | Event |
com.yworks.graph.model.StripeEventcom.yworks.graph.model.StripeEvent.LABEL_REMOVEDDispatched when a label has been removed from its stripe (column or row).
The label can be retrieved from the event's label property,
its former owner from the stripe property. The parent
property is always null.
| stripeChanged | Event |
com.yworks.graph.model.StripeEventcom.yworks.graph.model.StripeEvent.STRIPE_CHANGEDDispatched when a stripe (column or row) has been changed.
The new stripe can be retrieved from the event's stripe property,
its owner from the parent property.
| stripeCreated | Event |
com.yworks.graph.model.StripeEventcom.yworks.graph.model.StripeEvent.STRIPE_CREATEDDispatched when a new stripe (column or row) is created.
The new stripe can be retrieved from the event's stripe property,
its new owner from the parent property.
| stripeRemoved | Event |
com.yworks.graph.model.StripeEventcom.yworks.graph.model.StripeEvent.STRIPE_REMOVEDDispatched when a stripe (column or row) is removed from its parent.
The new stripe can be retrieved from the event's stripe property,
its former owner from the parent property.