Last updated

API / geotoolkit / schematics / factory / GrayScaleComponentFactoryRegistry / GrayScaleComponentFactoryRegistry

Class: GrayScaleComponentFactoryRegistry

factory.GrayScaleComponentFactoryRegistry.GrayScaleComponentFactoryRegistry

Schematics components factory registry extension to make use of gray-scale elements representation

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new GrayScaleComponentFactoryRegistry(setupDefaults, aliases)

new GrayScaleComponentFactoryRegistry(setupDefaults?, aliases?)

Parameters

Name Type Description
Optional setupDefaultsbooleanwhen "false" the registry is created empty
Optional aliasesRecord<string, string | string[]>components names aliases

Inherited from

ComponentNodeFactoryRegistry.constructor

Methods

clear

clear(): GrayScaleComponentFactoryRegistry

Clears the content.

Returns

GrayScaleComponentFactoryRegistry

this

Inherited from

ComponentNodeFactoryRegistry.clear


containsFactory

containsFactory(componentName): boolean

Checks if componentName is associatedwith a node factory

Parameters

Name Type Description
componentNamestringcomponent name associated with node factory

Returns

boolean

true if a factory is found; false otherwise

Inherited from

ComponentNodeFactoryRegistry.containsFactory


dispose

dispose(): void

Dispose.

Returns

void

Inherited from

ComponentNodeFactoryRegistry.dispose


getAliases

getAliases(): Record<string, string | string[]>

Gets aliases map
Note that a copy of aliases map is returned.

Returns

Record<string, string | string[]>

aliases

Inherited from

ComponentNodeFactoryRegistry.getAliases


getClassName

getClassName(): string

Returns

string

Inherited from

ComponentNodeFactoryRegistry.getClassName


getFactory

getFactory(componentName): AbstractComponentNodeFactory

Gets node factory associated with the componentName passed. Return null if node factory not found.

Parameters

Name Type Description
componentNamestringcomponent name associated with node factory

Returns

AbstractComponentNodeFactory

Inherited from

ComponentNodeFactoryRegistry.getFactory


getRegisteredComponents

getRegisteredComponents(): string[]

Gets array of registered component names

Returns

string[]

Inherited from

ComponentNodeFactoryRegistry.getRegisteredComponents


hasEventListener

hasEventListener(type, callback?): boolean

Check if a list of event listeners for this type contains this listener

Parameters

Name Type Description
typestringtype of event or property
Optional callbackFunctionto be called, if null, check if any callback is registered

Returns

boolean

Inherited from

ComponentNodeFactoryRegistry.hasEventListener


isDisposed

isDisposed(): boolean

Returns whether this object has been disposed

Returns

boolean

Inherited from

ComponentNodeFactoryRegistry.isDisposed


isSilent

isSilent(): boolean

Return true if the event dispatcher doesn't notify any events

Returns

boolean

Inherited from

ComponentNodeFactoryRegistry.isSilent


notify

notify<E>(type, source, args?): GrayScaleComponentFactoryRegistry

Notify listeners

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEevent types
sourceComponentNodeFactoryRegistryof the event
Optional argsEventMap[E]arguments of the event

Returns

GrayScaleComponentFactoryRegistry

this

Inherited from

ComponentNodeFactoryRegistry.notify


off

off<E>(type?, callback?): GrayScaleComponentFactoryRegistry

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.

Type parameters

NameType
Eextends string

Parameters

Name Type Description
Optional typeEtype of the event
Optional callback(eventType: E, sender: GrayScaleComponentFactoryRegistry, args: EventMap[E]) => voidfunction to be called

Returns

GrayScaleComponentFactoryRegistry

this

Inherited from

ComponentNodeFactoryRegistry.off


on

on<E>(type, callback): GrayScaleComponentFactoryRegistry

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.

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEtype of event or property
callback(eventType: E, sender: GrayScaleComponentFactoryRegistry, args: EventMap[E]) => voidto be called

Returns

GrayScaleComponentFactoryRegistry

this

Inherited from

ComponentNodeFactoryRegistry.on


setAliases

setAliases(jsonNamesToAliases, extendExisting?): GrayScaleComponentFactoryRegistry

Sets component name(s) aliases map

Parameters

Name Type Description
jsonNamesToAliasesRecord<string, string | string[]>aliases
Optional extendExistingbooleanextend existing overlapping mapping nodes flag; "false" stands for replacing existing mapping nodes if overlapped

Returns

GrayScaleComponentFactoryRegistry

this

Inherited from

ComponentNodeFactoryRegistry.setAliases


setFactory

setFactory(componentName, parameter2, parameter3?): GrayScaleComponentFactoryRegistry

Set componentName-to-nodeFactory link.

Parameters

Name Type Description
componentNamestringcomponent name associated with node factory
parameter2AbstractComponentNodeFactory | (data?: Element) => ComponentNodenode factory OR method returning a ComponentNode implementation instance.
Optional parameter3(geometryData: Entity) => booleanmethod to validate component geometry data

Returns

GrayScaleComponentFactoryRegistry

this

Inherited from

ComponentNodeFactoryRegistry.setFactory


setMapping

setMapping(mapping): GrayScaleComponentFactoryRegistry

Sets componentName-to-componentFactory mapping.

Example

factoryRegistry.setMapping([
{ name: 'MyComponent1', factory: new MyComponent1Factory()},
{ name: 'MyComponent2', factory: new MyComponent2Factory()},
//...
]);

Parameters

Name Type Description
mapping{ factory: AbstractComponentNodeFactory | (data?: Element) => ComponentNode ; name: string }[]array of pairs as follows:

Returns

GrayScaleComponentFactoryRegistry

this

Inherited from

ComponentNodeFactoryRegistry.setMapping


setSilent

setSilent(bool): GrayScaleComponentFactoryRegistry

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

GrayScaleComponentFactoryRegistry

this

Inherited from

ComponentNodeFactoryRegistry.setSilent


setupDefaults

setupDefaults(): GrayScaleComponentFactoryRegistry

Populates the factory registry with default mapping for component factories

Returns

GrayScaleComponentFactoryRegistry

this

Overrides

ComponentNodeFactoryRegistry.setupDefaults


getClassName

Static getClassName(): string

Returns

string

Inherited from

ComponentNodeFactoryRegistry.getClassName