API / geotoolkit / layout / HorizontalBoxLayout / HorizontalBoxLayout
layout.HorizontalBoxLayout.HorizontalBoxLayout
The HorizontalBoxLayout class lines up child elements geotoolkit.layout.ILayoutable horizontally.
Each child will get at least its desired width and at most its desired height, minimum and maximum height.
If height is not specified a child takes a height of layout area. This area can be passed via method setRect or
as a parameter of the layout.
The desired width can be specified in model parent units or in percentage to width of the a layout area.
↳
HorizontalBoxLayout
Constructors
| [new HorizontalBoxLayout(dstRect, alignment, direction)](/solutions/geotoolkit/apis/classes/geotoolkit.layout.horizontalboxlayout.horizontalboxlayout.md#new horizontalboxlayout(dstrect, alignment, direction)) | [new HorizontalBoxLayout(options)](/solutions/geotoolkit/apis/classes/geotoolkit.layout.horizontalboxlayout.horizontalboxlayout.md#new horizontalboxlayout(options)) |
|---|
Methods
Css Properties
Constructors
• new HorizontalBoxLayout(dstRect?, alignment?, direction?)
| Name | Type | Description |
|---|---|---|
Optional dstRect | Rect | optional layout area |
Optional alignment | Alignment | vertical alignment |
Optional direction | Direction | optional direction of layout |
BoxLayout.constructor
• new HorizontalBoxLayout(options?)
| Name | Type |
|---|---|
Optional options | Options |
BoxLayout.constructor
Methods
▸ add(node): HorizontalBoxLayout
Adds layoutable element
| Name | Type | Description |
|---|---|---|
node | ILayoutable | ILayoutable[] | Iterator<ILayoutable> | layoutable element(s) |
▸ clear(): HorizontalBoxLayout
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
▸ getAlignment(): Alignment
Returns vertical alignment
alignment vertical alignment
▸ getClassName(): string
string
▸ getDirection(): Direction
Returns direction of layout
▸ 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
▸ 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): HorizontalBoxLayout
Inserts layoutable element
| Name | Type | Description |
|---|---|---|
index | number | index where element will be inserted |
node | ILayoutable | ILayoutable[] | Iterator<ILayoutable> | layoutable element(s) |
▸ invalidateLayout(): HorizontalBoxLayout
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?): HorizontalBoxLayout
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?): HorizontalBoxLayout
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?): HorizontalBoxLayout
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: HorizontalBoxLayout, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): HorizontalBoxLayout
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: HorizontalBoxLayout, args: EventMap[E]) => void | to be called |
this
▸ remove(node): HorizontalBoxLayout
Removes a layoutable node if found
| Name | Type | Description |
|---|---|---|
node | ILayoutable | layoutable element |
▸ setAlignment(alignment): HorizontalBoxLayout
Sets vertical alignment
| Name | Type | Description |
|---|---|---|
alignment | Alignment | alignment |
this
▸ setDirection(value): HorizontalBoxLayout
Set direction
| Name | Type | Description |
|---|---|---|
value | Direction | direction |
this
▸ setProperties(properties?): HorizontalBoxLayout
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options | An object containing the properties to set |
this
▸ setRect(dstRect): HorizontalBoxLayout
Sets rectangular layout area
| Name | Type | Description |
|---|---|---|
dstRect | Rect | rectangular layout area |
this
▸ setReverse(reverse): HorizontalBoxLayout
Set reverse order iteration flag
| Name | Type | Description |
|---|---|---|
reverse | boolean | reverse order flag |
this
▸ setSilent(bool): HorizontalBoxLayout
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ Static getClassName(): string
string