API / geotoolkit / layout / RegularGridLayout / RegularGridLayout
layout.RegularGridLayout.RegularGridLayout
Children are arranged in a grid based on number of Rows and Columns in the grid.
↳
RegularGridLayout
Constructors
| [new RegularGridLayout(properties)](/solutions/geotoolkit/apis/classes/geotoolkit.layout.regulargridlayout.regulargridlayout.md#new regulargridlayout(properties)) | [new RegularGridLayout(rowCount, colCount, containerDirection, dstRect)](/solutions/geotoolkit/apis/classes/geotoolkit.layout.regulargridlayout.regulargridlayout.md#new regulargridlayout(rowcount, colcount, containerdirection, dstrect)) |
|---|
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
columncount | number | Columncount columncount |
direction | ContainerDirection | Direction of the layout |
rect | Rect | Bounds of the layout |
rect-height | number | Height |
rect-readonly | boolean | Readonly |
rect-width | number | Width |
rect-x | number | Left |
rect-y | number | Top |
reverse | boolean | Reverse flag |
rowcount | number | Rowcount rowcount |
Constructors
• new RegularGridLayout(properties?)
| Name | Type | Description |
|---|---|---|
Optional properties | Options | properties objecta |
BoxLayout.constructor
• new RegularGridLayout(rowCount?, colCount?, containerDirection?, dstRect?)
| Name | Type | Description |
|---|---|---|
Optional rowCount | number | number of columns for layout |
Optional colCount | number | number of rows for layout |
Optional containerDirection | ContainerDirection | direction for container's layout |
Optional dstRect | Rect | rectangular layout area |
BoxLayout.constructor
Methods
▸ add(node): RegularGridLayout
Adds layoutable element
| Name | Type | Description |
|---|---|---|
node | ILayoutable | ILayoutable[] | Iterator<ILayoutable> | layoutable element(s) |
▸ clear(): RegularGridLayout
Remove all children items from layout
▸ clone(): Layout
All subclasses should override copyConstructor or provide custom implementation for this method
▸ Protected copyConstructor(src): void
Copy constructor function.
Function used as part of the cloning mechanism.
Implementations should copy the given instance state to this instance.
| Name | Type | Description |
|---|---|---|
src | Layout | Source to copy from |
void
▸ dispose(): void
Dispose.
void
▸ getClassName(): string
string
▸ getColumnCount(): number
Gets number of columns for layout
number
▸ getDirection(): ContainerDirection
Gets direction of the container that this layout for
▸ getIterator(targets?): Iterator<ILayoutable>
| Name | Type | Description |
|---|---|---|
Optional targets | ILayoutable[] | Iterator<ILayoutable> | optional, items for iterator |
▸ getLayoutable(index): ILayoutable
Return node by index
| Name | Type |
|---|---|
index | number |
▸ getLayoutableCount(): number
Return number of layoutable nodes
number
▸ getPreferredSize(rect, targets?): Rect
Return the preferable size of children. Default implementation returns desired rect
| Name | Type | Description |
|---|---|---|
rect | Rect | desired rect to layout |
Optional targets | ILayoutable[] | Iterator<ILayoutable> | array of nodes supposed to layout |
▸ getProperties(): Options
Gets all the properties pertaining to this object
properties An object containing the properties of the layout
▸ getRect(): Rect
Gets rectangular layout area
rectangular layout area ("undefined" by default)
▸ getReverse(): boolean
Returns true if layout is in reverse order
boolean
▸ getRowCount(): number
Gets number of rows for layout
number
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
▸ indexOfLayoutable(node): number
Return index of layoutable node ( index of the specified child or -1 if node is not in layoutable list)
| Name | Type | Description |
|---|---|---|
node | ILayoutable | node to check index |
number
▸ insert(index, node): RegularGridLayout
Inserts layoutable element
| Name | Type | Description |
|---|---|---|
index | number | index where element will be inserted |
node | ILayoutable | ILayoutable[] | Iterator<ILayoutable> | layoutable element(s) |
▸ invalidateLayout(): RegularGridLayout
Notify that layout is invalidated. Send event Events.LayoutInvalidated
this
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ layout(layoutRect?, targets?): RegularGridLayout
Performs layout operation
| Name | Type | Description |
|---|---|---|
Optional layoutRect | Rect | desired rect to layout |
Optional targets | ILayoutable[] | Iterator<ILayoutable> | array of nodes or iterator of nodes supposed to layout |
this
▸ notify<E>(type, source, args?): RegularGridLayout
Notify listeners
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | event types |
source | Layout | of the event |
Optional args | EventMap[E] | arguments of the event |
this
▸ off<E>(type?, callback?): RegularGridLayout
Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
Optional type | E | type of the event |
Optional callback | (eventType: E, sender: RegularGridLayout, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): RegularGridLayout
Attach listener on event that will be called whenever the specified event is delivered to the target
If the callback function is already in the list of event listeners for this target, the function is not added a second time.
If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: RegularGridLayout, args: EventMap[E]) => void | to be called |
this
▸ remove(node): RegularGridLayout
Removes a layoutable node if found
| Name | Type | Description |
|---|---|---|
node | ILayoutable | layoutable element |
▸ setColumnCount(colCount): RegularGridLayout
Sets number of columns for layout
| Name | Type | Description |
|---|---|---|
colCount | number | number of columns for layout |
this
▸ setDirection(direction): RegularGridLayout
Sets direction for container's layout
| Name | Type | Description |
|---|---|---|
direction | ContainerDirection | direction for container's layout |
this
▸ setProperties(properties?): RegularGridLayout
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options | An object containing the properties to set |
this
▸ setRect(dstRect): RegularGridLayout
Sets rectangular layout area
| Name | Type | Description |
|---|---|---|
dstRect | Rect | rectangular layout area |
this
▸ setReverse(reverse): RegularGridLayout
Set reverse order iteration flag
| Name | Type | Description |
|---|---|---|
reverse | boolean | reverse order flag |
this
▸ setRowCount(rowCount): RegularGridLayout
Sets number of rows for layout
| Name | Type | Description |
|---|---|---|
rowCount | number | number of rows for layout |
this
▸ setSilent(bool): RegularGridLayout
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ Static getClassName(): string
string