Class ItemHandler

Package: @aurigma/design-atoms

Constructors

(constructor)(item)

Constructs a new instance of the ItemHandler class

Declaration

constructor(item?: Item);

Parameters

Type	Name	Description
Item	item

Properties

_callbacks

Declaration

protected _callbacks: any[];

Property Value

Type	Description
any[]

_controlPoints

Declaration

protected _controlPoints: PointF[];

Property Value

Type	Description
PointF[]

_handlerUpdated

Declaration

protected _handlerUpdated: Deferred<void>;

Property Value

Type	Description
Deferred<void>

_isDisposed

Declaration

protected _isDisposed: boolean;

Property Value

Type	Description
boolean

_itemPropertyChangedEvent

Declaration

protected _itemPropertyChangedEvent: EventWithSenderArg<ItemHandler, string>;

Property Value

Type	Description
EventWithSenderArg<ItemHandler, string>

_permissions

Declaration

protected _permissions: Permission;

Property Value

Type	Description
Permission

_tag

Declaration

protected _tag: any;

Property Value

Type	Description
any

_throttleSizeChanging

Declaration

protected _throttleSizeChanging: any;

Property Value

Type	Description
any

_uniqueId

Declaration

protected _uniqueId: string;

Property Value

Type	Description
string

blendMode

Declaration

get blendMode(): BlendMode;

Property Value

Type	Description
BlendMode

bounds

Declaration

get bounds(): RectangleF;

Property Value

Type	Description
RectangleF

canvas

Declaration

get canvas(): ICanvas;

set canvas(value: ICanvas);

Property Value

Type	Description
ICanvas

changeItemOnUpdate

Declaration

get changeItemOnUpdate(): boolean;

set changeItemOnUpdate(value: boolean);

Property Value

Type	Description
boolean

controlPoints

Declaration

get controlPoints(): PointF[];

set controlPoints(v: PointF[]);

Property Value

Type	Description
PointF[]

DEFAULT_CONTAINER_TRANSPARENCY_ENABLED

Declaration

static readonly DEFAULT_CONTAINER_TRANSPARENCY_ENABLED = true;

DEFAULT_CONTAINER_TRANSPARENCY_LEVEL

Declaration

static readonly DEFAULT_CONTAINER_TRANSPARENCY_LEVEL = 0.8;

hasLayoutAncestor

Declaration

get hasLayoutAncestor(): boolean;

Property Value

Type	Description
boolean

index

Declaration

get index(): number;

Property Value

Type	Description
number

isLoadingImage

Declaration

get isLoadingImage(): boolean;

set isLoadingImage(value: boolean);

Property Value

Type	Description
boolean

isNormalRenderingType

Declaration

get isNormalRenderingType(): boolean;

Property Value

Type	Description
boolean

isUpdating

Declaration

get isUpdating(): boolean;

Property Value

Type	Description
boolean

item

Declaration

set item(item: Item);

Property Value

Type	Description
Item

layer

Declaration

get layer(): Layer;

set layer(v: Layer);

Property Value

Type	Description
Layer

locked

Declaration

get locked(): boolean;

set locked(v: boolean);

Property Value

Type	Description
boolean

name

Declaration

get name(): string;

set name(v: string);

Property Value

Type	Description
string

parentGroupItemHandler

Declaration

get parentGroupItemHandler(): GroupItemHandler;

Property Value

Type	Description
GroupItemHandler

ready

Declaration

get ready(): boolean;

Property Value

Type	Description
boolean

renderState

Declaration

get renderState(): RenderState;

set renderState(v: RenderState);

Property Value

Type	Description
RenderState

tag

Declaration

get tag(): any;

set tag(v: any);

Property Value

Type	Description
any

typeName

Declaration

static readonly typeName: string;

Property Value

Type	Description
string

uniqueId

Declaration

get uniqueId(): string;

set uniqueId(v: string);

Property Value

Type	Description
string

visible

Declaration

get visible(): boolean;

set visible(v: boolean);

Property Value

Type	Description
boolean

Methods

_applyDataItem(item, itemHandlerData)

Declaration

protected _applyDataItem(item: any, itemHandlerData: any): void;

Parameters

Type	Name	Description
any	item
any	itemHandlerData

Returns

Type	Description
void

_callService(methodName, data, success, failure, externalCanvas)

Declaration

protected _callService(methodName: any, data: any, success: any, failure: any, externalCanvas: ICanvas): void;

Parameters

Type	Name	Description
any	methodName
any	data
any	success
any	failure
ICanvas	externalCanvas

Returns

Type	Description
void

_createDataInstance(itemHandler)

Declaration

protected _createDataInstance(itemHandler?: ItemHandler): ItemHandlerData;

Parameters

Type	Name	Description
ItemHandler	itemHandler

Returns

Type	Description
ItemHandlerData

_dispatchReadyEvent()

Declaration

protected _dispatchReadyEvent(): void;

Returns

Type	Description
void

_getColors()

Declaration

protected _getColors(): Color[];

Returns

Type	Description
Color[]

_getDataItem()

Declaration

protected _getDataItem(): string;

Returns

Type	Description
string

_getDefaultPermissions()

Declaration

protected _getDefaultPermissions(): IPermissions;

Returns

Type	Description
IPermissions

_getItem()

Declaration

protected _getItem(): Item;

Returns

Type	Description
Item

_getItemPermissions()

Declaration

protected _getItemPermissions(): IPermissions;

Returns

Type	Description
IPermissions

_getLayer()

Declaration

protected _getLayer(): Layer;

Returns

Type	Description
Layer

_isGroupHandler()

Declaration

protected _isGroupHandler(): boolean;

Returns

Type	Description
boolean

_isIgnorePermissionsMode()

Declaration

protected _isIgnorePermissionsMode(): boolean;

Returns

Type	Description
boolean

_isLoadingImage()

Declaration

protected _isLoadingImage(): boolean;

Returns

Type	Description
boolean

_isReady()

Declaration

protected _isReady(): boolean;

Returns

Type	Description
boolean

_modifyItem(modify)

Declaration

protected _modifyItem(modify: (i: Item) => void): void;

Parameters

Type	Name	Description
(i: Item) => void	modify

Returns

Type	Description
void

_onAddedOnCanvas(canvas, supressUpdate)

Declaration

protected _onAddedOnCanvas(canvas: ICanvas, supressUpdate?: boolean): void;

Parameters

Type	Name	Description
ICanvas	canvas
boolean	supressUpdate

Returns

Type	Description
void

_onItemPropertyChanged(sender, propertyName)

Declaration

protected _onItemPropertyChanged(sender: Item, propertyName: string): void;

Parameters

Type	Name	Description
Item	sender
string	propertyName

Returns

Type	Description
void

_onItemVisibilityChanged()

Declaration

protected _onItemVisibilityChanged(): void;

Returns

Type	Description
void

_onRemovedFromCanvas(canvas)

Declaration

protected _onRemovedFromCanvas(canvas: any): void;

Parameters

Type	Name	Description
any	canvas

Returns

Type	Description
void

_onValidateBeforeCallServiceFailed()

Declaration

protected _onValidateBeforeCallServiceFailed(): void;

Returns

Type	Description
void

_refreshState()

Declaration

protected _refreshState(): void;

Returns

Type	Description
void

_setDataItem(item, itemHandlerData)

Declaration

protected _setDataItem(item: Item, itemHandlerData: any): void;

Parameters

Type	Name	Description
Item	item
any	itemHandlerData

Returns

Type	Description
void

_setIsLoadingImage(value)

Declaration

protected _setIsLoadingImage(value: boolean): void;

Parameters

Type	Name	Description
boolean	value

Returns

Type	Description
void

_setItem(item)

Declaration

protected _setItem(item: Item): void;

Parameters

Type	Name	Description
Item	item

Returns

Type	Description
void

_subscribeItemEvents()

Declaration

protected _subscribeItemEvents(): void;

Returns

Type	Description
void

_unsubscribeItemEvents()

Declaration

protected _unsubscribeItemEvents(): void;

Returns

Type	Description
void

_update(additionalArgs, beforeUpdate, afterUpdate)

Declaration

protected _update(additionalArgs: any, beforeUpdate: any, afterUpdate: any): void;

Parameters

Type	Name	Description
any	additionalArgs
any	beforeUpdate
any	afterUpdate

Returns

Type	Description
void

_updateActiveWebServiceCall(callPromise)

Declaration

protected _updateActiveWebServiceCall(callPromise: Utils.ICancelablePromise<any>): Promise<void>;

Parameters

Type	Name	Description
Utils.ICancelablePromise<any>	callPromise

Returns

Type	Description
Promise<void>

_updateImpl(beforeUpdate, afterUpdate)

Declaration

protected _updateImpl(beforeUpdate?: Function, afterUpdate?: Function): Promise<void>;

Parameters

Type	Name	Description
Function	beforeUpdate
Function	afterUpdate

Returns

Type	Description
Promise<void>

_updateVisibility()

Declaration

protected _updateVisibility(): void;

Returns

Type	Description
void

_validateBeforeCallService()

Declaration

protected _validateBeforeCallService(): boolean;

Returns

Type	Description
boolean

addChanged(handler)

Declaration

addChanged(handler: (sender: ItemHandler) => any): void;

Parameters

Type	Name	Description
(sender: ItemHandler) => any	handler

Returns

Type	Description
void

addChanging(handler)

Declaration

addChanging(handler: (sender: Item) => any): void;

Parameters

Type	Name	Description
(sender: Item) => any	handler

Returns

Type	Description
void

addItemPropertyChanged(handler)

Declaration

addItemPropertyChanged(handler: (sender: ItemHandler, propertyName: string) => any): void;

Parameters

Type	Name	Description
(sender: ItemHandler, propertyName: string) => any	handler

Returns

Type	Description
void

addReady(handler)

Declaration

addReady(handler: (sender: ItemHandler) => any): void;

Parameters

Type	Name	Description
(sender: ItemHandler) => any	handler

Returns

Type	Description
void

beginUpdate()

Declaration

beginUpdate(): void;

Returns

Type	Description
void

dispose()

Declaration

dispose(): void;

Returns

Type	Description
void

draw(itemHandlerCtx, clippingPath, textureCanvas, textureCanvasCtx, memoryCanvas, memoryCanvasCtx, canvasRenderer, isMasked)

Declaration

draw(itemHandlerCtx: CanvasRenderingContext2D, clippingPath: Path, textureCanvas: HTMLCanvasElement, textureCanvasCtx: CanvasRenderingContext2D, memoryCanvas: HTMLCanvasElement, memoryCanvasCtx: CanvasRenderingContext2D, canvasRenderer: ICanvasRenderer, isMasked: boolean): void;

Parameters

Type	Name	Description
CanvasRenderingContext2D	itemHandlerCtx
Path	clippingPath
HTMLCanvasElement	textureCanvas
CanvasRenderingContext2D	textureCanvasCtx
HTMLCanvasElement	memoryCanvas
CanvasRenderingContext2D	memoryCanvasCtx
ICanvasRenderer	canvasRenderer
boolean	isMasked

Returns

Type	Description
void

drawItemHandler(itemHandlerCtx, originalCtx)

Declaration

drawItemHandler(itemHandlerCtx: CanvasRenderingContext2D, originalCtx?: CanvasRenderingContext2D): void;

Parameters

Type	Name	Description
CanvasRenderingContext2D	itemHandlerCtx
CanvasRenderingContext2D	originalCtx

Returns

Type	Description
void

endTransform(changed, resized, supressOnChanged)

Declaration

endTransform(changed: boolean, resized: boolean, supressOnChanged?: boolean): void;

Parameters

Type	Name	Description
boolean	changed
boolean	resized
boolean	supressOnChanged

Returns

Type	Description
void

endUpdate()

Declaration

endUpdate(): void;

Returns

Type	Description
void

getChangedEvent()

Declaration

getChangedEvent(): EventObject<ItemHandler>;

Returns

Type	Description
EventObject<ItemHandler>

getChangingEvent()

Declaration

getChangingEvent(): EventObject<Item>;

Returns

Type	Description
EventObject<Item>

getColors()

Declaration

getColors(): Color[];

Returns

Type	Description
Color[]

getData(type)

Declaration

getData(type: "asObject"): ItemHandlerData;

Parameters

Type	Name	Description
"asObject"	type

Returns

Type	Description
ItemHandlerData

getData()

Declaration

getData(): string;

Returns

Type	Description
string

getPermissions()

Declaration

getPermissions(): Permission;

Returns

Type	Description
Permission

getTypeName()

Declaration

getTypeName(): string;

Returns

Type	Description
string

hasBlendMode()

Declaration

hasBlendMode(): boolean;

Returns

Type	Description
boolean

hitTest(point)

Declaration

hitTest(point: PointF): IHitTestResult;

Parameters

Type	Name	Description
PointF	point

Returns

Type	Description
IHitTestResult

initialize()

Declaration

initialize(): void;

Returns

Type	Description
void

isEmpty()

Declaration

isEmpty(): boolean;

Returns

Type	Description
boolean

isGroupHandler(itemHandler)

Declaration

static isGroupHandler(itemHandler: any): itemHandler is IGroupHandler;

Parameters

Type	Name	Description
any	itemHandler

Returns

Type	Description
itemHandler is IGroupHandler

isHighlightNeeded()

Declaration

isHighlightNeeded(): boolean;

Returns

Type	Description
boolean

isLocked()

Declaration

isLocked(): boolean;

Returns

Type	Description
boolean

isVisible()

Declaration

isVisible(): boolean;

Returns

Type	Description
boolean

onErrorResponse(error, activeCall)

Declaration

onErrorResponse(error: any, activeCall?: WebServiceCallType): void;

Parameters

Type	Name	Description
any	error
WebServiceCallType	activeCall

Returns

Type	Description
void

onSuccessResponse(activeCall)

Declaration

onSuccessResponse(activeCall?: WebServiceCallType): void;

Parameters

Type	Name	Description
WebServiceCallType	activeCall

Returns

Type	Description
void

processEvent(e)

Declaration

processEvent(e: any): void;

Parameters

Type	Name	Description
any	e

Returns

Type	Description
void

quickUpdate()

Declaration

quickUpdate(): void;

Returns

Type	Description
void

raiseChanged()

Declaration

raiseChanged(): void;

Returns

Type	Description
void

raiseChanging(param)

Declaration

raiseChanging(param?: Item): void;

Parameters

Type	Name	Description
Item	param

Returns

Type	Description
void

removeChanged(handler)

Declaration

removeChanged(handler: (sender: ItemHandler) => any): void;

Parameters

Type	Name	Description
(sender: ItemHandler) => any	handler

Returns

Type	Description
void

removeChanging(handler)

Declaration

removeChanging(handler: (sender: Item) => any): void;

Parameters

Type	Name	Description
(sender: Item) => any	handler

Returns

Type	Description
void

removeItemPropertyChanged(handler)

Declaration

removeItemPropertyChanged(handler: (sender: ItemHandler, propertyName: string) => any): void;

Parameters

Type	Name	Description
(sender: ItemHandler, propertyName: string) => any	handler

Returns

Type	Description
void

removeReady(handler)

Declaration

removeReady(handler: (sender: ItemHandler) => any): void;

Parameters

Type	Name	Description
(sender: ItemHandler) => any	handler

Returns

Type	Description
void

resetPermissions()

Declaration

resetPermissions(): void;

Returns

Type	Description
void

setData(v)

Declaration

setData(v: any): void;

Parameters

Type	Name	Description
any	v

Returns

Type	Description
void

startTransform()

Declaration

startTransform(): void;

Returns

Type	Description
void

transformChanged()

Declaration

protected transformChanged(): void;

Returns

Type	Description
void

update(beforeUpdate, afterUpdate)

Declaration

update(beforeUpdate?: Function, afterUpdate?: Function): void;

Parameters

Type	Name	Description
Function	beforeUpdate
Function	afterUpdate

Returns

Type	Description
void

updateActiveColorWebServiceCall(callPromise, updateForAll)

Declaration

updateActiveColorWebServiceCall(callPromise: Utils.ICancelablePromise<any>, updateForAll: boolean): Promise<void>;

Parameters

Type	Name	Description
Utils.ICancelablePromise<any>	callPromise
boolean	updateForAll

Returns

Type	Description
Promise<void>

updateAsync(beforeUpdate, afterUpdate)

Declaration

updateAsync(beforeUpdate?: Function, afterUpdate?: Function): Promise<void>;

Parameters

Type	Name	Description
Function	beforeUpdate
Function	afterUpdate

Returns

Type	Description
Promise<void>

updated()

Declaration

updated(): void;

Returns

Type	Description
void

updateForExternalCanvas(canvas)

Declaration

updateForExternalCanvas(canvas: ICanvas): void;

Parameters

Type	Name	Description
ICanvas	canvas

Returns

Type	Description
void

updateItem(item)

Declaration

updateItem(item: Item): void;

Parameters

Type	Name	Description
Item	item

Returns

Type	Description
void

validateActiveColorWebServiceCall()

Declaration

validateActiveColorWebServiceCall(): void;

Returns

Type	Description
void

waitUpdate()

Declaration

waitUpdate(): Promise<void>;

Returns

Type	Description
Promise<void>