Class UIElementColumn <BackgroundClass >

Properties

scale

scale: Vec2<Scale>

theme

theme: Theme

Methods

addElement

addElement(builder: UIElementBuilder<UiElementType>, index: number): UiElementType

Type parameters
- UiElementType: UIPart
Parameters
- builder: UIElementBuilder<UiElementType>
- Default value index: number
Returns UiElementType

Created UiElement

addGap

addGap(fixedSize: pixel, index: number): UILayoutGap

Parameters
- Default value fixedSize: pixel
- Default value index: number
Returns UILayoutGap

Gap object

dispose

dispose(): this

Returns this

Object itself for fluent interface

getBackground

getBackground(): BackgroundClass

Returns BackgroundClass

Background object

getDraggingMode

getDraggingMode(): UIDraggingModes

Implementation of UIElement.getDraggingMode

Returns UIDraggingModes

Object itself

getHighlighted

getHighlighted(): boolean

Returns boolean

True for highlighted state of object and false for basic

getIsUnderMouse

getIsUnderMouse(): boolean

Implementation of UIElement.getIsUnderMouse

Returns boolean

Boolean for is object under mouse currently

getMargin

getMargin(): Margin

Implementation of UIElement.getMargin

Returns Margin

Margin datastructure

getMemberCount

getMemberCount(): number

Returns number

Number

getMembers

getMembers(): Array<UIPart>

Returns Array<UIPart>

getMinimumSize

getMinimumSize(): pixel | undefined

Returns pixel | undefined

Min size Layout should occupy (in direction of layout) or undefined to disable feature

getMouseInteractions

getMouseInteractions(): boolean

Implementation of UIElement.getMouseInteractions

Returns boolean

True if any member of Layout has mouse interactions enabled.

getMouseStyle

getMouseStyle(): UIMouseStyle

Implementation of UIElement.getMouseStyle

Returns UIMouseStyle

Interface for defining how mouse should look when hovering over UI object

getOrigin

getOrigin(): Point

Implementation of UIElement.getOrigin

Returns Point

Vec2 with each plane in range [-1, 1], where 0 is middle

getPadding

getPadding(): Margin

Returns Margin

Margin datastructure

getPixelSize

getPixelSize(): Point

Returns Point

getPosition

getPosition(relativePosition: Point, spaceOfInterest: UISpace): Point

Parameters
- Default value relativePosition: Point
- Default value spaceOfInterest: UISpace
Returns Point

Object itself for fluent itself

getSize

getSize(spaceOfInterest: UISpace): Point

Parameters
- Default value spaceOfInterest: UISpace
Returns Point

Object size in pixels

isDisposed

isDisposed(): boolean

Returns boolean

True if all sub-elements have been disposed, false if not.

offMouseClick

offMouseClick(token: Token): boolean

Implementation of UIElement.offMouseClick

Parameters
- token: Token
Returns boolean

True if the listener is successfully removed and false if it is not found

offMouseDoubleClick

offMouseDoubleClick(token: Token): boolean

Implementation of UIElement.offMouseDoubleClick

Parameters
- token: Token
Returns boolean

True if the listener is successfully removed and false if it is not found

offMouseDown

offMouseDown(token: Token): boolean

Implementation of UIElement.offMouseDown

Parameters
- token: Token
Returns boolean

True if the listener is successfully removed and false if it is not found

offMouseDrag

offMouseDrag(token: Token): boolean

Implementation of UIElement.offMouseDrag

Parameters
- token: Token
Returns boolean

True if the listener is successfully removed and false if it is not found

offMouseDragStart

offMouseDragStart(token: Token): boolean

Implementation of UIElement.offMouseDragStart

Parameters
- token: Token
Returns boolean

True if the listener is successfully removed and false if it is not found

offMouseDragStop

offMouseDragStop(token: Token): boolean

Implementation of UIElement.offMouseDragStop

Parameters
- token: Token
Returns boolean

True if the listener is successfully removed and false if it is not found

offMouseEnter

offMouseEnter(token: Token): boolean

Implementation of UIElement.offMouseEnter

Parameters
- token: Token
Returns boolean

True if the listener is successfully removed and false if it is not found

offMouseLeave

offMouseLeave(token: Token): boolean

Implementation of UIElement.offMouseLeave

Parameters
- token: Token
Returns boolean

True if the listener is successfully removed and false if it is not found

offMouseMove

offMouseMove(token: Token): boolean

Implementation of UIElement.offMouseMove

Parameters
- token: Token
Returns boolean

True if the listener is successfully removed and false if it is not found

offMouseUp

offMouseUp(token: Token): boolean

Implementation of UIElement.offMouseUp

Parameters
- token: Token
Returns boolean

True if the listener is successfully removed and false if it is not found

offMouseWheel

offMouseWheel(token: Token): boolean

Implementation of UIElement.offMouseWheel

Parameters
- token: Token
Returns boolean

True if the listener is successfully removed and false if it is not found

offTouchEnd

offTouchEnd(token: Token): boolean

Implementation of UIElement.offTouchEnd

Parameters
- token: Token
Returns boolean

True if the listener is successfully removed and false if it is not found

offTouchMove

offTouchMove(token: Token): boolean

Implementation of UIElement.offTouchMove

Parameters
- token: Token
Returns boolean

True if the listener is successfully removed and false if it is not found

offTouchStart

offTouchStart(token: Token): boolean

Implementation of UIElement.offTouchStart

Parameters
- token: Token
Returns boolean

True if the listener is successfully removed and false if it is not found

onMouseClick

onMouseClick(listener: MouseEventHandler<this>): Token

Implementation of UIElement.onMouseClick

Parameters
- listener: MouseEventHandler<this>
Returns Token

Token-object that is a reference ID to the listener created.

onMouseDoubleClick

onMouseDoubleClick(listener: MouseEventHandler<this>): Token

Implementation of UIElement.onMouseDoubleClick

Parameters
- listener: MouseEventHandler<this>
Returns Token

onMouseDown

onMouseDown(listener: MouseEventHandler<this>): Token

Implementation of UIElement.onMouseDown

Parameters
- listener: MouseEventHandler<this>
Returns Token

onMouseDrag

onMouseDrag(listener: MouseDragEventHandler<this>): Token

Implementation of UIElement.onMouseDrag

Parameters
- listener: MouseDragEventHandler<this>
Returns Token

onMouseDragStart

onMouseDragStart(listener: MouseDragStartEventHandler<this>): Token

Implementation of UIElement.onMouseDragStart

Parameters
- listener: MouseDragStartEventHandler<this>
Returns Token

onMouseDragStop

onMouseDragStop(listener: MouseDragStopEventHandler<this>): Token

Implementation of UIElement.onMouseDragStop

Parameters
- listener: MouseDragStopEventHandler<this>
Returns Token

onMouseEnter

onMouseEnter(listener: MouseEventHandler<this>): Token

Implementation of UIElement.onMouseEnter

Parameters
- listener: MouseEventHandler<this>
Returns Token

Token-object that is a reference ID to the listener created.

onMouseLeave

onMouseLeave(listener: AbruptMouseEventHandler<this>): Token

Implementation of UIElement.onMouseLeave

Parameters
- listener: AbruptMouseEventHandler<this>
Returns Token

Token-object that is a reference ID to the listener created.

onMouseMove

onMouseMove(listener: MouseEventHandler<this>): Token

Implementation of UIElement.onMouseMove

Parameters
- listener: MouseEventHandler<this>
Returns Token

Token of subscription

onMouseUp

onMouseUp(listener: MouseEventHandler<this>): Token

Implementation of UIElement.onMouseUp

Parameters
- listener: MouseEventHandler<this>
Returns Token

onMouseWheel

onMouseWheel(listener: MouseWheelEventHandler<this>): Token

Implementation of UIElement.onMouseWheel

Parameters
- listener: MouseWheelEventHandler<this>
Returns Token

Token of subscription

onTouchEnd

onTouchEnd(listener: TouchEventHandler<this>): Token

Implementation of UIElement.onTouchEnd

Parameters
- listener: TouchEventHandler<this>
Returns Token

Token of subscription

onTouchMove

onTouchMove(listener: TouchEventHandler<this>): Token

Implementation of UIElement.onTouchMove

Parameters
- listener: TouchEventHandler<this>
Returns Token

Token of subscription

onTouchStart

onTouchStart(listener: TouchEventHandler<this>): Token

Implementation of UIElement.onTouchStart

Parameters
- listener: TouchEventHandler<this>
Returns Token

Token of subscription

restore

restore(): this

Returns this

Object itself itself for fluent interface

setBackground

setBackground(mutator: Mutator<BackgroundClass>): this

Parameters
- mutator: Mutator<BackgroundClass>
Returns this

Object itself for fluent interface

setDraggingMode

setDraggingMode(draggingMode: UIDraggingModes): this

Parameters
- Default value draggingMode: UIDraggingModes
Returns this

Object itself

setHighlighted

setHighlighted(isHighlighted: boolean): this

Parameters
- isHighlighted: boolean
Returns this

Object itself for fluent interface

setMargin

setMargin(margin: Partial<MMargin> | number): this

Implementation of UIElement.setMargin

Parameters
- margin: Partial<MMargin> | number
Returns this

Object itself

setMinimumSize

setMinimumSize(minSize: pixel | undefined): this

Parameters
- minSize: pixel | undefined
Returns this

Object itself

setMouseInteractions

setMouseInteractions(state: boolean): this

Implementation of UIElement.setMouseInteractions

Parameters
- state: boolean
Returns this

setMouseStyle

setMouseStyle(mouseStyle: UIMouseStyle): this

Implementation of UIElement.setMouseStyle

Parameters
- mouseStyle: UIMouseStyle
Returns this

Object itself

setOrigin

setOrigin(origin: Point): this

Implementation of UIElement.setOrigin

Parameters
- origin: Point
Returns this

Object itself

setPadding

setPadding(padding: Partial<Margin> | number): this

Parameters
- padding: Partial<Margin> | number
Returns this

Object itself

setPosition

setPosition(position: Point): this

Implementation of UIElement.setPosition

Parameters
- position: Point
Returns this

Object itself