Class TableWidget

The TableWidget class provides an item-based table view.

Hierarchy

Constructors

constructor

Properties

m_children m_container m_content m_dom m_headerView m_parent m_selected m_selectionMode

Accessors

blocked children columnCount css dom enabled headerView headerViewVisible height id left padding parent position rect rowCount selected selectionMode size style titles tooltip top visible width sender

Methods

addAttr addClass addColumn addRow attach bind cell clear clearChildren clearContents clearSelection close columnWidth delegate destroy detach emit free hasAttr hasClass hide insertChild insertColumn insertRow item raise removeAttr removeClass removeColumn removeRow scrollTo scrollToBottom scrollToTop set setColumnVisible setColumnWidth setFlex setItem setRowVisible show toggleAttr toggleClass unbind

Constructors

constructor

Properties

Protected m_children

m_children: Widget[] = []

Private m_container

m_container: TableItemContainer

Protected m_content

m_content: Widget

Protected m_dom

m_dom: HTMLElement

Private m_headerView

m_headerView: HeaderView

Protected m_parent

m_parent: Widget

Private m_selected

m_selected: TableItem[] = []

Private m_selectionMode

m_selectionMode: SelectionMode = SelectionMode.SingleSelection

Accessors

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[]

columnCount

  • get columnCount(): number

  • Returns the number of columns.

    Returns number

  • set columnCount(columnCount): void

  • Sets the number of columns in this table widget to columnCount.

    Parameters

    • columnCount: number

    Returns void

css

  • set css(style): void

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

    Parameters

    Returns void

dom

  • get dom(): HTMLElement

  • Returns the native DOM of this widget, user can directly manipulate the native DOM.

    Returns HTMLElement

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

headerView

  • get headerView(): HeaderView

  • Returns the header view of this table widget.

    Returns HeaderView

headerViewVisible

  • get headerViewVisible(): boolean

  • Returns whether the table widget is visible or not.

    Returns boolean

  • set headerViewVisible(visible): void

  • Sets whether the table widget is visible or not.

    Parameters

    • visible: 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

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

padding

  • set padding(padding): void

  • Sets the padding of this scroll area to padding.

    Parameters

    • padding: 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

    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

rowCount

  • get rowCount(): number

  • Returns the number of rows.

    Returns number

  • set rowCount(rowCount): void

  • Sets the number of rows in this table widget to rowCount.

    Parameters

    • rowCount: number

    Returns void

selected

  • get selected(): TableItem[]

  • Returns the list of selected items.

    Returns TableItem[]

  • set selected(selected): void

  • Sets the selected items to the given selected.

    Parameters

    Returns void

selectionMode

  • get selectionMode(): SelectionMode

  • Returns the selection mode of the table widget.

    Returns SelectionMode

  • set selectionMode(mode): void

  • Sets the selection mode of the table widget to mode.

    Parameters

    Returns void

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

titles

  • get titles(): string[]

  • Returns the header labels of the table widget.

    Returns string[]

  • set titles(titles): void

  • Sets the header labels of the table widget using titles.

    Parameters

    • titles: 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

Methods

addAttr

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

    Parameters

    • attr: string

    Returns void

addClass

  • 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

addColumn

  • Adds a new column with title to the end of the table widget.

    Parameters

    • title: string = ''

    Returns void

addRow

  • Adds a new row to the end of the table widget.

    Returns void

Protected attach

  • Returns void

bind

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

    Type Parameters

    Parameters

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

        • Parameters

          Returns void

    Returns void

  • Parameters

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

        • Parameters

          • Rest ...data: any[]

          Returns void

    Returns void

Protected cell

  • Parameters

    • row: number
    • column: number

    Returns TableItemCell

clear

  • Removes all items in the table widget, this will also remove all header items. If you don't want to remove all header items, use clearContents.

    Returns void

clearChildren

  • Clears all widgets in the list of children.

    Returns void

clearContents

  • Removes all items excluding header items from the table widget. See also clear.

    Returns void

clearSelection

  • Deselects all selected items.

    Returns void

close

  • 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

columnWidth

  • Returns the width of column column.

    Parameters

    • column: number

    Returns number

delegate

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

    Type Parameters

    Parameters

    Returns void

  • Parameters

    Returns void

destroy

  • 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

Protected detach

  • Returns void

emit

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

    Type Parameters

    Parameters

    Returns boolean

  • Parameters

    • name: string
    • Rest ...data: any[]

    Returns boolean

Protected free

  • Frees the resources.See also destroy.

    Returns void

hasAttr

  • Returns whether this widget contains the attribute.

    Parameters

    • attr: string

    Returns boolean

hasClass

  • Returns whether this widget contains the class name.

    Parameters

    • className: string

    Returns boolean

hide

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

    Returns void

insertChild

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

    Parameters

    Returns void

insertColumn

  • Inserts a new column with title into the table widget at position index.

    Parameters

    • index: number
    • title: string = ''

    Returns void

insertRow

  • Inserts a new row into the table widget at position index.

    Parameters

    • index: number

    Returns void

item

  • Returns the item of the given row and column if it has been set; otherwise returns undefined.

    Parameters

    • row: number
    • column: number

    Returns TableItem

raise

  • 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

  • Removes the attribute of this widget.

    Parameters

    • attr: string

    Returns void

removeClass

  • Removes the class name of this widget.

    Parameters

    • className: string

    Returns void

removeColumn

  • Removes the column index and all its items from the table widget.

    Parameters

    • index: number

    Returns void

removeRow

  • Removes the row index and all its items from the table widget.

    Parameters

    • index: number

    Returns void

scrollTo

  • Scrolls this scroll area if necessary to ensure that the widget is visible. By default, scroll animation is closed.

    Parameters

    • widget: Widget
    • animate: boolean = false
    • duration: number = 300

    Returns void

scrollToBottom

  • Scrolls this scroll area to the bottom. By default, scroll animation is closed.

    Parameters

    • animate: boolean = false
    • duration: number = 300

    Returns void

scrollToTop

  • Scrolls this scroll area to the top. By default, scroll animation is closed.

    Parameters

    • animate: boolean = false
    • duration: number = 300

    Returns void

set

  • Sets the item of the given row and column to item.

    Parameters

    Returns void

setColumnVisible

  • Sets whether column index is visible or not.

    Parameters

    • index: number
    • visible: boolean

    Returns void

setColumnWidth

  • Sets the width of column column to width.

    Parameters

    • column: number
    • width: number

    Returns void

setFlex

  • Sets whether the scroll area uses flex layout. See also setFlex

    Parameters

    • orientation: Orientation
    • Optional alignItem: "center" | "inherit" | "stretch" | "flex-start" | "flex-end" | "initial" | "baseline"
    • Optional spacing: number

    Returns void

setItem

  • Sets the item of the given row and column to a new item with text.

    Parameters

    • row: number
    • column: number
    • text: string

    Returns TableItem

setRowVisible

  • Sets whether row index is visible or not.

    Parameters

    • index: number
    • visible: boolean

    Returns void

show

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

    Returns void

toggleAttr

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

    Parameters

    • attr: string
    • on: boolean

      true or false

    Returns void

toggleClass

  • 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

  • Removes the specified watcher for the event named name.

    Type Parameters

    Parameters

    • name: K

    Returns void

  • Parameters

    • name: string

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc