API / geotoolkit / schematics / factory / ComponentNodeFactoryRegistry / ComponentNodeFactoryRegistry
factory.ComponentNodeFactoryRegistry.ComponentNodeFactoryRegistry
Schematics components factory registry
↳
ComponentNodeFactoryRegistry
Methods
Constructors
• new ComponentNodeFactoryRegistry(setupDefaults?, aliases?)
| Name | Type | Description |
|---|---|---|
Optional setupDefaults | boolean | when "false" the registry is created empty |
Optional aliases | Record<string, string | string[]> | components names aliases |
EventDispatcher.constructor
Methods
▸ clear(): ComponentNodeFactoryRegistry
Clears the content.
this
▸ containsFactory(componentName): boolean
Checks if componentName is associatedwith a node factory
| Name | Type | Description |
|---|---|---|
componentName | string | component name associated with node factory |
boolean
true if a factory is found; false otherwise
▸ dispose(): void
Dispose.
void
▸ getAliases(): Record<string, string | string[]>
Gets aliases map
Note that a copy of aliases map is returned.
Record<string, string | string[]>
aliases
▸ getClassName(): string
string
▸ getFactory(componentName): AbstractComponentNodeFactory
Gets node factory associated with the componentName passed. Return null if node factory not found.
| Name | Type | Description |
|---|---|---|
componentName | string | component name associated with node factory |
▸ getRegisteredComponents(): string[]
Gets array of registered component names
string[]
▸ 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
EventDispatcher.hasEventListener
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ notify<E>(type, source, args?): ComponentNodeFactoryRegistry
Notify listeners
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | event types |
source | ComponentNodeFactoryRegistry | of the event |
Optional args | EventMap[E] | arguments of the event |
this
▸ off<E>(type?, callback?): ComponentNodeFactoryRegistry
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: ComponentNodeFactoryRegistry, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): ComponentNodeFactoryRegistry
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: ComponentNodeFactoryRegistry, args: EventMap[E]) => void | to be called |
this
▸ setAliases(jsonNamesToAliases, extendExisting?): ComponentNodeFactoryRegistry
Sets component name(s) aliases map
| Name | Type | Description |
|---|---|---|
jsonNamesToAliases | Record<string, string | string[]> | aliases |
Optional extendExisting | boolean | extend existing overlapping mapping nodes flag; "false" stands for replacing existing mapping nodes if overlapped |
this
▸ setFactory(componentName, parameter2, parameter3?): ComponentNodeFactoryRegistry
Set componentName-to-nodeFactory link.
| Name | Type | Description |
|---|---|---|
componentName | string | component name associated with node factory |
parameter2 | AbstractComponentNodeFactory | (data?: Element) => ComponentNode | node factory OR method returning a ComponentNode implementation instance. |
Optional parameter3 | (geometryData: Entity) => boolean | method to validate component geometry data |
this
▸ setMapping(mapping): ComponentNodeFactoryRegistry
Sets componentName-to-componentFactory mapping.
Example
factoryRegistry.setMapping([
{ name: 'MyComponent1', factory: new MyComponent1Factory()},
{ name: 'MyComponent2', factory: new MyComponent2Factory()},
//...
]);| Name | Type | Description |
|---|---|---|
mapping | { factory: AbstractComponentNodeFactory | (data?: Element) => ComponentNode ; name: string }[] | array of pairs as follows: |
this
▸ setSilent(bool): ComponentNodeFactoryRegistry
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setupDefaults(): ComponentNodeFactoryRegistry
Populates the factory registry with default mapping for component factories
this
▸ Static getClassName(): string
string