Class GroupItemHandler

Inheritance

ItemHandler

BaseRectangleItemHandler

GroupItemHandler

Package: @aurigma/design-atoms

Constructors

(constructor)(item, itemHandlers, textWhizz)

Constructs a new instance of the GroupItemHandler class

Declaration

constructor(item: GroupItem, itemHandlers?: ItemHandler[], textWhizz?: typeof TextWhizz);

Parameters

Type	Name	Description
GroupItem	item
ItemHandler[]	itemHandlers
typeof TextWhizz	textWhizz

Properties

_cachedPermissions

Declaration

_cachedPermissions: Permission;

Property Value

Type	Description
Permission

_calculateRectangleFromChild

Declaration

protected get _calculateRectangleFromChild(): boolean;

Property Value

Type	Description
boolean

_onChildItemHandlerChanging

Declaration

protected _onChildItemHandlerChanging: (sender: Item) => void;

Property Value

Type	Description
(sender: Item) => void

item

Declaration

get item(): GroupItem;

Property Value

Type	Description
GroupItem

itemHandlers

Declaration

get itemHandlers(): Collection<ItemHandler>;

set itemHandlers(value: Collection<ItemHandler>);

Property Value

Type	Description
Collection<ItemHandler>

typeName

Declaration

static readonly typeName: string;

Property Value

Type	Description
string

Methods

_endTransform(changed, resized, supressOnChanged)

Declaration

_endTransform(changed: any, resized: any, supressOnChanged?: boolean): void;

Parameters

Type	Name	Description
any	changed
any	resized
boolean	supressOnChanged

Returns

Type	Description
void

_getChildrenHighlights()

Declaration

protected _getChildrenHighlights(): RotatedRectangleF[];

Returns

Type	Description
RotatedRectangleF[]

_getColors()

Declaration

protected _getColors(): Color[];

Returns

Type	Description
Color[]

_getRectangle()

Declaration

protected _getRectangle(): RotatedRectangleF;

Returns

Type	Description
RotatedRectangleF

_getRectangleFromChildren()

Declaration

protected _getRectangleFromChildren(): RotatedRectangleF;

Returns

Type	Description
RotatedRectangleF

_onAddedOnCanvas(canvas)

Declaration

protected _onAddedOnCanvas(canvas: ICanvas): void;

Parameters

Type	Name	Description
ICanvas	canvas

Returns

Type	Description
void

_onChildItemPropertyChanged(sender, property)

Declaration

protected _onChildItemPropertyChanged(sender: Item, property: string): void;

Parameters

Type	Name	Description
Item	sender
string	property

Returns

Type	Description
void

_onItemAdded(data)

Declaration

protected _onItemAdded(data?: {
        item: Item;
        index: number;
    }): void;

Parameters

Type	Name	Description
{ item: Item; index: number; }	data

Returns

Type	Description
void

_onItemHandlerAdded(data)

Declaration

protected _onItemHandlerAdded(data?: {
        item: ItemHandler;
        index: number;
    }): void;

Parameters

Type	Name	Description
{ item: ItemHandler; index: number; }	data

Returns

Type	Description
void

_onItemHandlerRemoved(data)

Declaration

protected _onItemHandlerRemoved(data?: {
        item: ItemHandler;
        index: number;
    }): void;

Parameters

Type	Name	Description
{ item: ItemHandler; index: number; }	data

Returns

Type	Description
void

_onItemPropertyChanged(sender, propertyName)

Declaration

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

Parameters

Type	Name	Description
GroupItem	sender
string	propertyName

Returns

Type	Description
void

_onItemRemoved(data)

Declaration

protected _onItemRemoved(data?: {
        item: Item;
        index: number;
    }): void;

Parameters

Type	Name	Description
{ item: Item; index: number; }	data

Returns

Type	Description
void

_onRemovedFromCanvas(canvas)

Declaration

protected _onRemovedFromCanvas(canvas: ICanvas): void;

Parameters

Type	Name	Description
ICanvas	canvas

Returns

Type	Description
void

_onTransformRectangle(startRectangle, endRectangle, highlightOnly)

Declaration

protected _onTransformRectangle(startRectangle: RotatedRectangleF, endRectangle: RotatedRectangleF, highlightOnly: boolean): void;

Parameters

Type	Name	Description
RotatedRectangleF	startRectangle
RotatedRectangleF	endRectangle
boolean	highlightOnly

Returns

Type	Description
void

_updateImpl()

Declaration

protected _updateImpl(): Promise<void>;

Returns

Type	Description
Promise<void>

applyToItems(func)

Declaration

applyToItems(func: (handler: ItemHandler) => any): void;

Parameters

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

Returns

Type	Description
void

drawItemHandler(itemHandlerCtx)

Declaration

drawItemHandler(itemHandlerCtx: CanvasRenderingContext2D): void;

Parameters

Type	Name	Description
CanvasRenderingContext2D	itemHandlerCtx

Returns

Type	Description
void

getHighlightRectangles(options)

Declaration

getHighlightRectangles(options?: IGetHighlightRectanglesOptions): RotatedRectangleF[];

Parameters

Type	Name	Description
IGetHighlightRectanglesOptions	options

Returns

Type	Description
RotatedRectangleF[]

getNestedItemHandlers(excludeGroupItems, reversedZorder, onlyVisible)

Declaration

getNestedItemHandlers(excludeGroupItems?: boolean, reversedZorder?: boolean, onlyVisible?: boolean): ItemHandler[];

Parameters

Type	Name	Description
boolean	excludeGroupItems
boolean	reversedZorder
boolean	onlyVisible

Returns

Type	Description
ItemHandler[]

getOrderedItems()

Declaration

getOrderedItems(): Item[];

Returns

Type	Description
Item[]

getPermissions()

Declaration

getPermissions(): Permission;

Returns

Type	Description
Permission

isChildVisible(itemHandler)

Declaration

isChildVisible(itemHandler: ItemHandler): boolean;

Parameters

Type	Name	Description
ItemHandler	itemHandler

Returns

Type	Description
boolean

isHighlightNeeded()

Declaration

isHighlightNeeded(): boolean;

Returns

Type	Description
boolean

onResized()

Declaration

onResized(): boolean;

Returns

Type	Description
boolean

quickUpdate()

Declaration

quickUpdate(): void;

Returns

Type	Description
void

replaceItemHandler(oldHandler, newHandler)

Declaration

replaceItemHandler(oldHandler: ItemHandler, newHandler: ItemHandler): void;

Parameters

Type	Name	Description
ItemHandler	oldHandler
ItemHandler	newHandler

Returns

Type	Description
void

resetPermissions()

Declaration

resetPermissions(): void;

Returns

Type	Description
void

setItemHandlers(itemHandlers)

Declaration

setItemHandlers(itemHandlers: ItemHandler[]): void;

Parameters

Type	Name	Description
ItemHandler[]	itemHandlers

Returns

Type	Description
void

setRectangle(rectangle, supressOnChanged)

Declaration

setRectangle(rectangle: RotatedRectangleF, supressOnChanged?: boolean): void;

Parameters

Type	Name	Description
RotatedRectangleF	rectangle
boolean	supressOnChanged

Returns

Type	Description
void

startTransform()

Declaration

startTransform(): void;

Returns

Type	Description
void

transformChanged()

Declaration

transformChanged(): void;

Returns

Type	Description
void

updateNestedItemHandlers(updateFunc)

Declaration

updateNestedItemHandlers(updateFunc: HandlerUpdateFunc): boolean;

Parameters

Type	Name	Description
HandlerUpdateFunc	updateFunc

Returns

Type	Description
boolean