API / geotoolkit / layout / FlexboxLayout / FlexboxLayout
layout.FlexboxLayout.FlexboxLayout
The custom implementation of CSS Flexbox Layout module
↳
FlexboxLayout
Constructors
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
aligncontent | AlignContent | Specifies the default alignment for flex lines inside the flexible container |
alignitems | AlignItems | Specifies the default alignment for flex items inside the flexible container |
flexdirection | FlexDirection | The direction of the flexible items |
flexwrap | FlexWrap | Specifies whether the flexible items should wrap or not |
justifycontent | JustifyContent | Aligns the flexible container's items when the items do not use all available space on the main-axis |
Constructors
• new FlexboxLayout(options?)
| Name | Type |
|---|---|
Optional options | Options |
ContainerLayout.constructor
Methods
▸ add(item): FlexboxLayout
Adds layoutable element
| Name | Type | Description |
|---|---|---|
item | ILayoutable | ILayoutable[] | Iterator<ILayoutable> | layoutable element(s) |
▸ clear(): FlexboxLayout
Remove all children items from layout
▸ clone(): FlexboxLayout
All subclasses should override copyConstructor or provide custom implementation for this method
▸ Protected copyConstructor(src): FlexboxLayout
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 | FlexboxLayout | Source to copy from |
ContainerLayout.copyConstructor
▸ dispose(): void
Dispose.
void
▸ getAlignContent(): AlignContent
Gets a mode that specifies the default alignment for flex lines inside the flexible container.
alignment
▸ getAlignItems(): AlignItems
Gets a mode that specifies the default alignment for items inside the flexible container
alignment
▸ getClassName(): string
string
▸ getFlexDirection(): FlexDirection
Gets a mode that specifies the direction of the flexible items
direction
▸ getFlexWrap(): FlexWrap
Gets a mode that specifies whether the flexible items should wrap or not
wrap mode
▸ getIterator(targets): Iterator<ILayoutable>
| Name | Type | Description |
|---|---|---|
targets | ILayoutable[] | Iterator<ILayoutable> | optional, items for iterator |
▸ getJustifyContent(): JustifyContent
Gets a mode that aligns the flexible container's items when the items do not use all available space on the main-axis
alignment
▸ 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 |
ContainerLayout.getPreferredSize
▸ getProperties(): OptionsOut
Gets all the properties pertaining to this object
properties An object containing the properties of the layout
▸ 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
ContainerLayout.hasEventListener
▸ insert(index, item): FlexboxLayout
Inserts layoutable element
| Name | Type | Description |
|---|---|---|
index | number | index where element will be inserted |
item | ILayoutable | ILayoutable[] | Iterator<ILayoutable> | layoutable element(s) |
▸ invalidateLayout(): FlexboxLayout
Notify that layout is invalidated. Send event Events.LayoutInvalidated
this
ContainerLayout.invalidateLayout
▸ 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(rect?, targets?): FlexboxLayout
Performs layout operation
| Name | Type | Description |
|---|---|---|
Optional rect | 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?): FlexboxLayout
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?): FlexboxLayout
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: FlexboxLayout, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): FlexboxLayout
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: FlexboxLayout, args: EventMap[E]) => void | to be called |
this
▸ remove(item): FlexboxLayout
Removes a layoutable node if found
| Name | Type | Description |
|---|---|---|
item | ILayoutable | layoutable element |
▸ setAlignContent(alignment): FlexboxLayout
Sets a mode that specifies the default alignment for flex lines inside the flexible container. Modifies the behavior of the FlexWrap property.
| Name | Type | Description |
|---|---|---|
alignment | AlignContent | the alignment |
▸ setAlignItems(alignment): FlexboxLayout
Sets a mode that specifies the default alignment for items inside the flexible container
| Name | Type | Description |
|---|---|---|
alignment | AlignItems | the alignment |
▸ setFlexDirection(direction): FlexboxLayout
Sets a mode that specifies the direction of the flexible items
| Name | Type | Description |
|---|---|---|
direction | FlexDirection | the direction |
▸ setFlexWrap(wrap): FlexboxLayout
Sets a mode that specifies whether the flexible items should wrap or not
| Name | Type | Description |
|---|---|---|
wrap | FlexWrap | the wrap mode |
▸ setJustifyContent(alignment): FlexboxLayout
Sets a mode that aligns the flexible container's items when the items do not use all available space on the main-axis
| Name | Type | Description |
|---|---|---|
alignment | JustifyContent | the alignment |
▸ setProperties(properties?): FlexboxLayout
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options | An object containing the properties to set |
this
▸ setSilent(bool): FlexboxLayout
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ Static getClassName(): string
string