API / geotoolkit / layout / ContainerLayout / ContainerLayout
layout.ContainerLayout.ContainerLayout
Define an abstract class to operate with <code>ILayoutable</code> children
Children can be added using methods: <code>add</code> or <code>insert</code> or can be passed as parameter in method <code>layout</code> If layout has any item added directly it ignores items passed to <code>layout</code> as parameter
Constructors
- [new ContainerLayout()](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.layout.containerlayout.containerlayout.md#new containerlayout())
Methods
Methods
▸ Abstract add(node): ContainerLayout
Adds layoutable element
| Name | Type | Description |
|---|---|---|
node | ILayoutable | ILayoutable[] | Iterator<ILayoutable> | layoutable element(s) |
▸ Abstract clear(): ContainerLayout
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.<br> Function used as part of the cloning mechanism.<br> Implementations should copy the given instance state to this instance.<br>
| Name | Type | Description |
|---|---|---|
src | Layout | Source to copy from |
void
▸ dispose(): void
Dispose.
void
▸ getClassName(): string
string
▸ Abstract getIterator(targets?): Iterator<ILayoutable>
| Name | Type | Description |
|---|---|---|
Optional targets | ILayoutable[] | Iterator<ILayoutable> | optional, items for iterator |
Iterator<ILayoutable>
▸ 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(): Record<string, any>
Gets all the properties pertaining to this object
Record<string, any>
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
▸ Abstract insert(index, node): ContainerLayout
Inserts layoutable element
| Name | Type | Description |
|---|---|---|
index | number | index where element will be inserted |
node | ILayoutable | ILayoutable[] | Iterator<ILayoutable> | layoutable element(s) |
▸ invalidateLayout(): ContainerLayout
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
▸ Abstract layout(area?, targets?): ContainerLayout
Performs layout operation
| Name | Type | Description |
|---|---|---|
Optional area | 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?): ContainerLayout
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?): ContainerLayout
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: ContainerLayout, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): ContainerLayout
Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> 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. </p>
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: ContainerLayout, args: EventMap[E]) => void | to be called |
this
▸ Abstract remove(node): ContainerLayout
Removes a layoutable node if found
| Name | Type | Description |
|---|---|---|
node | ILayoutable | layoutable element |
▸ setProperties(properties): ContainerLayout
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
properties | Record<string, any> | An object containing the properties to set |
this
▸ setSilent(bool): ContainerLayout
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ Static getClassName(): string
string