Packagecom.yworks.yfiles.layout.grid
Classpublic class ColumnDescriptor
InheritanceColumnDescriptor Inheritance YObject Inheritance Object
Implements Comparable

This class represents a column of a com.yworks.yfiles.layout.grid.PartitionGrid. The results of the calculation of the geometry of the column will be placed into the instances of this class after the layout.

See also

com.yworks.yfiles.layout.grid.PartitionGrid

Public Properties
 PropertyDefined By
  computedPosition : Number
Used to set the computed position (smaller x-coordinate) of the column after the layout has been calculated.
ColumnDescriptor
  computedWidth : Number
Used to set the computed width of the column after the layout has been calculated.
ColumnDescriptor
  index : int
[read-only] Returns the index of the column within the partition grid.
ColumnDescriptor
  indexFixed : Boolean
Getter: Returns whether the index of this column is fixed or whether the algorithm should try to find the best possible position.
ColumnDescriptor
  leftInset : Number
Specifies the left column insets where no element will lie in the resulting drawing.
ColumnDescriptor
  minimumWidth : Number
Getter: Returns the minimum column width.
ColumnDescriptor
  originalPosition : Number
Specifies the original position (smaller x-coordinate) of the column.
ColumnDescriptor
  originalWidth : Number
Specifies the original width of the column.
ColumnDescriptor
  rightInset : Number
Specifies the right column insets where no element will lie in the resulting drawing.
ColumnDescriptor
  tightness : Number
Getter: Returns the tightness factor of the column.
ColumnDescriptor
Public Methods
 MethodDefined By
  
ColumnDescriptor(init:Boolean = true)
ColumnDescriptor
  
compareTo(o:Object):int
ColumnDescriptor
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
ColumnDescriptor
 Inherited
hashCode():int
YObject
Property Detail
computedPositionproperty
computedPosition:Number

Used to set the computed position (smaller x-coordinate) of the column after the layout has been calculated.


Implementation
    public function get computedPosition():Number
    public function set computedPosition(value:Number):void
computedWidthproperty 
computedWidth:Number

Used to set the computed width of the column after the layout has been calculated.


Implementation
    public function get computedWidth():Number
    public function set computedWidth(value:Number):void
indexproperty 
index:int  [read-only]

Returns the index of the column within the partition grid.


Implementation
    public function get index():int
indexFixedproperty 
indexFixed:Boolean

Getter: Returns whether the index of this column is fixed or whether the algorithm should try to find the best possible position. The default is true

Setter: Specifies whether a column's index is fixed or whether the index should be chosen automatically in order to minimize edge lengths.

For all columns where this property is set to true, the relative ordering given by the indices is preserved. The remaining columns may be resorted so that the overall edge lengths are minimized.

By default, this feature is enabled.


Implementation
    public function get indexFixed():Boolean
    public function set indexFixed(value:Boolean):void
leftInsetproperty 
leftInset:Number

Specifies the left column insets where no element will lie in the resulting drawing. The default is 0.0d.


Implementation
    public function get leftInset():Number
    public function set leftInset(value:Number):void

Throws
IllegalArgumentException — if leftInset is negative
minimumWidthproperty 
minimumWidth:Number

Getter: Returns the minimum column width. The default is 0.0d.

Setter: Sets the minimum width of the column.


Implementation
    public function get minimumWidth():Number
    public function set minimumWidth(value:Number):void

Throws
IllegalArgumentException — if minimumWidth is negative
originalPositionproperty 
originalPosition:Number

Specifies the original position (smaller x-coordinate) of the column.


Implementation
    public function get originalPosition():Number
    public function set originalPosition(value:Number):void
originalWidthproperty 
originalWidth:Number

Specifies the original width of the column.


Implementation
    public function get originalWidth():Number
    public function set originalWidth(value:Number):void
rightInsetproperty 
rightInset:Number

Specifies the right column insets where no element will lie in the resulting drawing. The default is 0.0d.


Implementation
    public function get rightInset():Number
    public function set rightInset(value:Number):void

Throws
IllegalArgumentException — if rightInset is negative
tightnessproperty 
tightness:Number

Getter: Returns the tightness factor of the column. The default is 0.0d.

Setter: Sets the tightness factor of the column. The greater the value the more will the column to be forced to be of its minimal possible width. A value of 0.0d will disable compression of the column. A value of 1.0d will try to force the column to be of its minimum width (minimumWidth).


Implementation
    public function get tightness():Number
    public function set tightness(value:Number):void

Throws
IllegalArgumentException — if tightness is out of the valid range

See also

minimum width
Constructor Detail
ColumnDescriptor()Constructor
public function ColumnDescriptor(init:Boolean = true)



Parameters
init:Boolean (default = true)
Method Detail
compareTo()method
public function compareTo(o:Object):int

Parameters

o:Object

Returns
int
getClass()method 
override public function getClass():Class

Returns
Class




Wed Oct 7 2015, 04:43 PM +02:00