API / geotoolkit / layout / CompositeLayout / CompositeLayout
layout.CompositeLayout.CompositeLayout
Defines a container of layouts
↳
CompositeLayout
Constructors
Methods
Methods
▸ add(layout): CompositeLayout
Add a child layout(s)
▸ clearChildren(): void
Remove all child layouts from this composite layout
void
▸ clone(): Layout
All subclasses should override copyConstructor or provide custom implementation for this method
▸ Protected copyConstructor(src): void
copy constructor
| Name | Type | Description |
|---|---|---|
src | CompositeLayout | Source to copy from |
void
▸ dispose(): void
Dispose.
void
▸ getChild(i): Layout
Return layout by index
| Name | Type | Description |
|---|---|---|
i | number | index of the layout |
▸ getChildren(filter?): Iterator<Layout>
Return iterator by child layouts
| Name | Type | Description |
|---|---|---|
Optional filter | (item: Layout) => boolean | a filter function. Returns all layouts if null |
▸ getChildrenCount(): number
Return number of child layouts
number
▸ getClassName(): string
string
▸ getPreferredSize(rect, targets?): Rect
Return the preferable size of children. It returns an union of all children
| 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
▸ indexOfChild(layout): number
Return index of child ( index of the specified child or -1 if layout is not found)
| Name | Type | Description |
|---|---|---|
layout | Layout | layout to check index |
number
▸ insertChild(index, layout): CompositeLayout
Insert child layout at specified index
| Name | Type | Description |
|---|---|---|
index | number | specified index |
layout | Layout | a child layout to add |
▸ invalidateLayout(): CompositeLayout
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?): CompositeLayout
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?): CompositeLayout
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?): CompositeLayout
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: CompositeLayout, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): CompositeLayout
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: CompositeLayout, args: EventMap[E]) => void | to be called |
this
▸ removeChild(layout): CompositeLayout
Remove child layout
| Name | Type | Description |
|---|---|---|
layout | Layout | layout to be removed |
▸ setProperties(properties): CompositeLayout
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): CompositeLayout
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ Static getClassName(): string
string