Interface ICustomElement

This is the base Java abstract class, which are all Inner Core element types inherited from. In Java, to create custom element types, you can inherit your element class from this one as well. Whereas in JavaScript, you should use "custom" element type in description object, where you can specify custom behavior for different events. For more information about custom element types in JavaScript, see UI.UICustomElement.

interface ICustomElement {
    cleaner: IElementCleaner;
    description: object;
    descriptionWatcher: IScriptableWatcher;
    elementName: string;
    elementRect: Rect;
    isDirty: boolean;
    isTouched: boolean;
    window: Window;
    x: number;
    y: number;
    z: number;
    createTexture(obj: BitmapTypes): UI.Texture;
    debug(canvas: Canvas, scale: number): void;
    getBinding<T>(name: string): Rect | IElement | T;
    getCleanerCopy(): IElementCleaner;
    getScope(): object;
    invalidate(): void;
    isReleased(): boolean;
    onBindingUpdated<T>(name: string, val: T): void;
    onDraw(canvas: Canvas, scale: number): void;
    onRelease(): void;
    onReset(): void;
    onSetup<T>(desc: T): void;
    onTouchEvent(event: ITouchEvent): void;
    onTouchReleased(event: ITouchEvent): void;
    setBinding<T>(bindingName: string, value: T): void;
    setPosition(x: number, y: number): void;
    setSize(width: number, height: number): void;
    setupInitialBindings(container: UiAbstractContainer, elementName: string): void;
}

Hierarchy (view full)

Methods

createTexture debug getBinding getCleanerCopy getScope invalidate isReleased onBindingUpdated onDraw onRelease onReset onSetup onTouchEvent onTouchReleased setBinding setPosition setSize setupInitialBindings

Properties

cleaner description descriptionWatcher elementName elementRect isDirty isTouched window x y z

Methods

createTexture

debug

getBinding

  • getBinding<T>(name): Rect | IElement | T

  • Gets any value from the element.

    Type Parameters

    • T = any

    Parameters

    • name: string

      binding name, you can access the value from the element by this name; some binding names are reserved for additional element information, e.g. "element_obj" contains pointer to the current object and "element_rect" contains android.graphics.Rect object containing drawing rectangle

    Returns Rect | IElement | T

    Value that was get from the element or null if the element doesn't exist.

getCleanerCopy

getScope

invalidate

isReleased

onBindingUpdated

onDraw

onRelease

onReset

onSetup

onTouchEvent

onTouchReleased

setBinding

  • setBinding<T>(bindingName, value): void

  • Passes any value to the element.

    Type Parameters

    • T = any

    Parameters

    • bindingName: string

      binding name, you can access the value from the element by this name

    • value: T

      value to be passed to the element

    Returns void

setPosition

  • setPosition(x, y): void

  • Sets element's position in the window's unit coordinates.

    Parameters

    • x: number

      x position

    • y: number

      y position

    Returns void

setSize

  • setSize(width, height): void

  • Sets element's size in the window's unit coordinates.

    Parameters

    • width: number

      element's width

    • height: number

      element's height

    Returns void

setupInitialBindings

Properties

cleaner

cleaner: IElementCleaner

description

description: object

descriptionWatcher

descriptionWatcher: IScriptableWatcher

elementName

elementName: string

elementRect

elementRect: Rect

isDirty

isDirty: boolean

isTouched

isTouched: boolean

window

window: Window

x

x: number

y

y: number

z

z: number

Settings

Member Visibility

On This Page

Methods
Properties

Copyright © 2024 Nernar. Copyright © 2020 #mineprogramming. Built with ❤ and TypeDoc.