Packagecom.yworks.yfiles.layout.grid
Classpublic class RowDescriptor
InheritanceRowDescriptor Inheritance YObject Inheritance Object
Implements Comparable

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

See also

com.yworks.yfiles.layout.grid.PartitionGrid

Public Properties
 PropertyDefined By
  bottomInset : Number
Specifies the bottom row insets where no element will lie in the resulting drawing.
RowDescriptor
  computedHeight : Number
Used to set the computed height of the row after the layout has been calculated.
RowDescriptor
  computedPosition : Number
Used to set the computed position (smaller y-coordinate) of the row after the layout has been calculated.
RowDescriptor
  index : int
[read-only] Returns the index of the row within the partition grid.
RowDescriptor
  indexFixed : Boolean
Getter: Returns whether the index of this row is fixed or whether the algorithm should try to find the best possible position.
RowDescriptor
  minimumHeight : Number
Getter: Returns the minimum row height.
RowDescriptor
  originalHeight : Number
Specifies the original height of the row.
RowDescriptor
  originalPosition : Number
Specifies the original position (smaller y-coordinate) of the row.
RowDescriptor
  tightness : Number
Getter: Returns the tightness factor of the row.
RowDescriptor
  topInset : Number
Specifies the top row insets where no element will lie in the resulting drawing.
RowDescriptor
Public Methods
 MethodDefined By
  
RowDescriptor(init:Boolean = true)
RowDescriptor
  
compareTo(o:Object):int
RowDescriptor
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
RowDescriptor
 Inherited
hashCode():int
YObject
Property Detail
bottomInsetproperty
bottomInset:Number

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


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

Throws
IllegalArgumentException — if bottomInset is negative
computedHeightproperty 
computedHeight:Number

Used to set the computed height of the row after the layout has been calculated.


Implementation
    public function get computedHeight():Number
    public function set computedHeight(value:Number):void
computedPositionproperty 
computedPosition:Number

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


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

Returns the index of the row within the partition grid.


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

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

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

For all rows where this property is set to true, the relative ordering given by the indices is preserved. The remaining rows 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
minimumHeightproperty 
minimumHeight:Number

Getter: Returns the minimum row height. The default is 0.0d.

Setter: Sets the minimum height of the row.


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

Throws
IllegalArgumentException — if minimumHeight is negative
originalHeightproperty 
originalHeight:Number

Specifies the original height of the row.


Implementation
    public function get originalHeight():Number
    public function set originalHeight(value:Number):void
originalPositionproperty 
originalPosition:Number

Specifies the original position (smaller y-coordinate) of the row.


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

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

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


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 height
topInsetproperty 
topInset:Number

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


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

Throws
IllegalArgumentException — if topInset is negative
Constructor Detail
RowDescriptor()Constructor
public function RowDescriptor(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