API / geotoolkit / layout / AutoWrapLayout / AutoWrapLayout
layout.AutoWrapLayout.AutoWrapLayout
The Layout class provides an abstract class for all layouts in the toolkits. This class defines a virtual API for arranging children nodes using method layout, which has parameter area.
↳
AutoWrapLayout
Constructors
Methods
Constructors
• new AutoWrapLayout(layoutableNodes?)
Layout.constructor
Methods
▸ 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
▸ getLayoutableNodes(): Legend[]
Get layoutable nodes
Legend[]
The nodes which get layout when layout is called
▸ 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
▸ invalidateLayout(): AutoWrapLayout
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?): AutoWrapLayout
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?): AutoWrapLayout
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?): AutoWrapLayout
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: AutoWrapLayout, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): AutoWrapLayout
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: AutoWrapLayout, args: EventMap[E]) => void | to be called |
this
▸ setLayoutableNodes(nodes): AutoWrapLayout
Set layoutable nodes
this
▸ setProperties(properties): AutoWrapLayout
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): AutoWrapLayout
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ Static getClassName(): string
string