Class ColorButton

Static Readonly Horizontal

Static Readonly IconMask

Static Readonly LargeIcon

Static Readonly LargeMode

Static Readonly SmallIcon

Static Readonly SmallMode

Static Readonly Text

Static Readonly TextMask

Static Readonly TextMode

Static Readonly ToolMode

Static Readonly Vertical

blocked

• get blocked(): boolean

• Returns true if events are blocked; otherwise returns false.

  Returns boolean
• set blocked(blocked): void

• If blocked is true, then events emitted by this event watcher will be blocked, meaning that emitting an event will not trigger any callback functions that are bound to it.

  Parameters

  • blocked: boolean

  Returns void

children

• get children(): readonly Widget[]

• Returns the list of children.

  Returns readonly Widget[]

css

• set css(style): void

• Sets the style of this widget. See also id addClass.

  Parameters

  • style: Partial<StyleSheets>

  Returns void

dom

• get dom(): HTMLButtonElement

• Returns the dom of this button.

  Returns HTMLButtonElement

enabled

• get enabled(): boolean

• Returns whether this widget or its parent chain is enabled or not. By default, the value of this property is true.

  Returns boolean
• set enabled(enabled): void

• Sets whether this widget is enabled or not. Disabling a widget implicitly disables all its children, it is not possible to explicitly enable a child widget while its parent widget remains disabled.

  Parameters

  • enabled: boolean

  Returns void

height

• get height(): number

• Returns the height of this widget.

  Returns number
• set height(height): void

• Sets the height of this widget to the given height.

  Parameters

  • height: number

    The unit of height is px.

  Returns void

id

• get id(): string

• Returns the id of this widget.

  Returns string
• set id(id): void

• Set the id of this widget to the given id. The id is utilized to set the style of the widget. See also css

  Parameters

  • id: string

  Returns void

image

• get image(): string

• Returns the image shown on this button.

  Returns string
• set image(icon): void

• Sets the image shown on this button to the given icon.

  Parameters

  • icon: string

  Returns void

left

• get left(): number

• Returns the left coordinate of this widget within its parent widget.

  Returns number
• set left(left): void

• Sets the left coordinate of this widget within its parent widget.

  Parameters

  • left: number

    The unit of left is px.

  Returns void

mode

• get mode(): number

• Returns the mode of this button, the default mode is TextMode.

  The image is shown on this button when in icon mode. The image's default size is Size(16, 16). When in large icon mode, the image's size is Size(32, 32).

  Returns number
• set mode(mode): void

• Sets the mode of the button to the given mode.

  Parameters

  • mode: number

  Returns void

parent

• get parent(): Widget

• Returns the parent of this widget, or undefined if it does not have any parent widget.

  Returns Widget
• set parent(parent): void

• Sets the parent of the widget to the given parent. If the new parent widget is the old parent widget, this function does nothing.

  Parameters

  • parent: Widget

  Returns void

position

• get position(): Point

• Returns the position of this widget within its parent widget.

  Returns Point
• set position(position): void

• Sets the position of this widget to the given position.

  Parameters

  • position: Point

    The unit of position is px.

  Returns void

rect

• get rect(): Rect

• Returns the rect of this widget within the desktop.

  Returns Rect

size

• get size(): Size

• Returns the size of this widget.

  Returns Size
• set size(size): void

• Sets the size of this widget to the given size. If the size is Size(0, 0) will cause the widget to not appear on screen.

  Parameters

  • size: Size

    The unit of size is px.

  Returns void

style

• get style(): CSSStyleDeclaration

• Returns the style of this widget.

  Returns CSSStyleDeclaration

text

• get text(): string

• Returns the text shown on this button.

  Returns string
• set text(text): void

• Sets the text shown on this button to the given text.

  Parameters

  • text: string

  Returns void

tooltip

• get tooltip(): string

• Returns the tooltip of this widget. When the mouse hovers over the widget for a period of time(it can be set by Tooltip::WakeUpDelay), a message will automatically pop up, and it will disappear automatically when the mouse moves away. By default, the value of this property is an empty string.

  Returns string
• set tooltip(tooltip): void

• Sets the tooltip of this widget to the given tooltip.

  Parameters

  • tooltip: string

  Returns void

top

• get top(): number

• Returns the top coordinate of this widget within its parent widget.

  Returns number
• set top(top): void

• Sets the top coordinate of this widget to the given top.

  Parameters

  • top: number

    The unit of top is px.

  Returns void

visible

• get visible(): boolean

• Returns whether this widget or its parent chain is visible or not. By default, the value of this property is true.

  Returns boolean
• set visible(visible): void

• Sets whether this widget is visible or not. If an ancestor widget is not visible, the widget won't become visible until all its ancestors are visible.

  Parameters

  • visible: boolean

  Returns void

width

• get width(): number

• Returns the width of this widget.

  Returns number
• set width(width): void

• Sets the width of this widget to the given width.

  Parameters

  • width: number

    The unit of width is px.

  Returns void

Static sender

• get sender(): EventWatcher

• Returns the object that sent the event.

  Returns EventWatcher

addAttr

• addAttr(attr): void

• Adds the attribute of this widget. The attribute is utilized to set the style. See also css

  Parameters

  • attr: string

  Returns void

addClass

• addClass(className): void

• Adds the class name of this widget. The class name is utilized to set the style. See also css. All widgets with the same class name use the same style.

  Parameters

  • className: string

  Returns void

bind

• bind<K>(name, callback): void

• Adds a callback function that's going to be called when the event is emitted.

  Type Parameters

  • K extends keyof EventMap

  Parameters

  • name: K

  • callback: ((...data) => void)

    • • (...data): void

      • Parameters

        • Rest ...data: EventMap[K]

        Returns void

  Returns void
• bind(name, callback): void

• Parameters

  • name: string

  • callback: ((...data) => void)

    • • (...data): void

      • Parameters

        • Rest ...data: any[]

        Returns void

  Returns void

clearChildren

• clearChildren(): void

• Clears all widgets in the list of children.

  Returns void

close

• close(): void

• Closes this widget. This function is equivalent to setting this widget's parent to undefined. If the widget has no resources to free, call this function directly.

  Returns void

delegate

• delegate<K>(watcher, name): void

• Delegates this event watcher to handle the given watcher's event named name.

  Type Parameters

  • K extends keyof EventMap

  Parameters

  • watcher: EventWatcher

  • name: K

  Returns void
• delegate(watcher, name): void

• Parameters

  • watcher: EventWatcher

  • name: string

  Returns void

destroy

• destroy(): void

• Destroys the widget, all the widget's children are destroyed first. The widget is destroyed when it's parent is destroyed. When the widget is destroyed, make sure to release all resources, such as timers, etc. Releases the resources in the protected function free(), and the system will call this function automatically when the parent widget or itself is destroyed. See also free.

  Returns void

emit

• emit<K>(name, ...data): boolean

• Emits an arbitrary set of arguments to the callback function which is bound to the event named name.

  Type Parameters

  • K extends keyof EventMap

  Parameters

  • name: K

  • Rest ...data: EventMap[K]

  Returns boolean
• emit(name, ...data): boolean

• Parameters

  • name: string

  • Rest ...data: any[]

  Returns boolean

hasAttr

• hasAttr(attr): boolean

• Returns whether this widget contains the attribute.

  Parameters

  • attr: string

  Returns boolean

hasClass

• hasClass(className): boolean

• Returns whether this widget contains the class name.

  Parameters

  • className: string

  Returns boolean

hide

• hide(): void

• Hides the widget and its child widgets. This function is equivalent to setting the visible property to false.

  Returns void

insertChild

• insertChild(index, widget): void

• Inserts the child widget at index in the list of children.

  Parameters

  • index: number

  • widget: Widget

  Returns void

raise

• raise(): boolean

• Raises this widget to the front of the parent widget's children. The display order of this widget is determined by the order in which they appear in the parent widget's children.

  Returns boolean

removeAttr

• removeAttr(attr): void

• Removes the attribute of this widget.

  Parameters

  • attr: string

  Returns void

removeClass

• removeClass(className): void

• Removes the class name of this widget.

  Parameters

  • className: string

  Returns void

setFlex

• setFlex(orientation, alignItem?, spacing?): void

• Sets whether the widget uses flex layout.

  Parameters

  • orientation: Orientation

    Horizontal or vertical.

  • Optional alignItem: "center" | "inherit" | "stretch" | "flex-start" | "flex-end" | "initial" | "baseline"

    @see(https://developer.mozilla.org/en-US/docs/Web/CSS/align-items)

  • Optional spacing: number

    the spacing between widgets inside the layout.

  Returns void

show

• show(): void

• Shows the widget and its child widgets. This function is equivalent to setting the visible property to true.

  Returns void

toggleAttr

• toggleAttr(attr, on): void

• If param attr is true, adds the attribute, otherwise removes the attribute.

  Parameters

  • attr: string

  • on: boolean

    true or false

  Returns void

toggleClass

• toggleClass(className, on): void

• If param on is true, adds the class name, otherwise removes the class name.

  Parameters

  • className: string

  • on: boolean

    true or false

  Returns void

unbind

• unbind<K>(name): void

• Removes the specified watcher for the event named name.

  Type Parameters

  • K extends keyof EventMap

  Parameters

  • name: K

  Returns void
• unbind(name): void

• Parameters

  • name: string

  Returns void