[]
        
(Showing Draft Content)

ActionHide

Class: ActionHide

Represents an action that hides or shows one or more widget annotations.

Extends

Constructors

Constructor

new ActionHide(om): ActionHide;

Creates a new ActionHide.

Parameters

om

ObjectManager

ObjectManager that controls the lifetime of the ActionHide.

Returns

ActionHide

Overrides

ActionBase.constructor

Constructor

new ActionHide(): ActionHide;

Creates a new ActionHide.

Returns

ActionHide

Overrides

ActionBase.constructor

Accessors

hide

Get Signature

get hide(): boolean;

Gets or sets a flag indicating whether to hide (true) or show (false) the linked annotations. The default is true.

Returns

boolean


id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

ActionBase.id


linkedObjects

Get Signature

get linkedObjects(): (string | WidgetAnnotation)[];

Gets the objects linked with this action as an array. Each item is either a field name string or a WidgetAnnotation pointer.

Returns

(string | WidgetAnnotation)[]


om

Get Signature

get om(): ObjectManager;

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

ActionBase.om

Methods

addLinkedObject()

Call Signature

addLinkedObject(fieldName): void;

Adds a field name string to the linked objects collection.

Parameters
fieldName

string

Returns

void

Call Signature

addLinkedObject(annotation): void;

Adds a widget annotation to the linked objects collection.

Parameters
annotation

WidgetAnnotation

Returns

void


clearLinkedObjects()

clearLinkedObjects(): void;

Clears all linked objects from the collection.

Returns

void


free()

free(): void;

Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns

void

Inherited from

ActionBase.free


rebind()

rebind(omTo): void;

Rebinds the object from the current ObjectManager to the specified one.

Parameters

omTo

ObjectManager

The new ObjectManager for the object.

Returns

void

Inherited from

ActionBase.rebind