Class WindowedList<T>

Windowed list widget

Type Parameters

Hierarchy

Constructors

constructor

Properties

_addListeners _applyNoWindowingStyles _innerElement _isParentHidden _isScrolling _needsUpdate _onWidgetResize _removeListeners _resetScrollToItem _resetScrollToItemTimeout _resizeObserver _scrollRepaint _scrollToItem _scrollUpdateWasRequested _update _viewModel _windowElement node DEFAULT_WIDGET_SIZE

Accessors

dataset disposed hiddenMode id isAttached isDisposed isHidden isParentHidden isVisible layout parent title viewModel viewportNode

Methods

activate addClass children clearFlag close contains dispose fit handleEvent hasClass hide notifyLayout onActivateRequest onAfterAttach onAfterDetach onAfterHide onAfterShow onBeforeAttach onBeforeDetach onBeforeHide onBeforeShow onChildAdded onChildRemoved onCloseRequest onFitRequest onResize onScroll onStateChanged onUpdateRequest processMessage removeClass scrollTo scrollToItem setFlag setHidden show testFlag toggleClass update

Constructors

constructor

Properties

Private _addListeners

_addListeners: any

Private _applyNoWindowingStyles

_applyNoWindowingStyles: any

Private _innerElement

_innerElement: any

Private _isParentHidden

_isParentHidden: any

Private _isScrolling

_isScrolling: any

Private _needsUpdate

_needsUpdate: any

Private _onWidgetResize

_onWidgetResize: any

Private _removeListeners

_removeListeners: any

Private _resetScrollToItem

_resetScrollToItem: any

Private _resetScrollToItemTimeout

_resetScrollToItemTimeout: any

Private _resizeObserver

_resizeObserver: any

Private _scrollRepaint

_scrollRepaint: any

Private _scrollToItem

_scrollToItem: any

Private _scrollUpdateWasRequested

_scrollUpdateWasRequested: any

Private _update

_update: any

Protected _viewModel

_viewModel: T

Private _windowElement

_windowElement: any

Readonly node

node: HTMLElement

Get the DOM node owned by the widget.

Static Readonly DEFAULT_WIDGET_SIZE

DEFAULT_WIDGET_SIZE: 50 = 50

Default widget size

Accessors

dataset

  • get dataset(): DOMStringMap

  • The dataset for the widget's DOM node.

    Returns DOMStringMap

disposed

  • get disposed(): ISignal<this, void>

  • A signal emitted when the widget is disposed.

    Returns ISignal<this, void>

hiddenMode

  • get hiddenMode(): HiddenMode

  • Get the method for hiding the widget.

    Returns HiddenMode

  • set hiddenMode(value): void

  • Set the method for hiding the widget.

    Parameters

    • value: HiddenMode

    Returns void

id

  • get id(): string

  • Get the id of the widget's DOM node.

    Returns string

  • set id(value): void

  • Set the id of the widget's DOM node.

    Parameters

    • value: string

    Returns void

isAttached

  • get isAttached(): boolean

  • Test whether the widget's node is attached to the DOM.

    Returns boolean

isDisposed

  • get isDisposed(): boolean

  • Test whether the widget has been disposed.

    Returns boolean

isHidden

  • get isHidden(): boolean

  • Test whether the widget is explicitly hidden.

    Returns boolean

isParentHidden

  • get isParentHidden(): boolean

  • Whether the parent is hidden or not.

    This should be set externally if a container is hidden to stop updating the widget size when hidden.

    Returns boolean

  • set isParentHidden(v): void

  • Parameters

    • v: boolean

    Returns void

isVisible

  • get isVisible(): boolean

  • Test whether the widget is visible.

    Notes

    A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.

    Returns boolean

layout

  • get layout(): WindowedLayout

  • Widget layout

    Returns WindowedLayout

parent

  • get parent(): Widget

  • Get the parent of the widget.

    Returns Widget

  • set parent(value): void

  • Set the parent of the widget.

    Notes

    Children are typically added to a widget by using a layout, which means user code will not normally set the parent widget directly.

    The widget will be automatically removed from its old parent.

    This is a no-op if there is no effective parent change.

    Parameters

    Returns void

title

  • get title(): Title<Widget>

  • The title object for the widget.

    Notes

    The title object is used by some container widgets when displaying the widget alongside some title, such as a tab panel or side bar.

    Since not all widgets will use the title, it is created on demand.

    The owner property of the title is set to this widget.

    Returns Title<Widget>

Protected viewModel

  • get viewModel(): T

  • Windowed list view model

    Returns T

viewportNode

Methods

activate

  • Post an 'activate-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

addClass

  • Add a class name to the widget's DOM node.

    Parameters

    • name: string

      The class name to add to the node.

      Notes

      If the class name is already added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

children

  • Create an iterator over the widget's children.

    Returns IterableIterator<Widget>

    A new iterator over the children of the widget.

    Notes

    The widget must have a populated layout in order to have children.

    If a layout is not installed, the returned iterator will be empty.

clearFlag

  • Clear the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns void

close

  • Send a 'close-request' message to the widget.

    Notes

    This is a simple convenience method for sending the message.

    Returns void

contains

  • Test whether a widget is a descendant of this widget.

    Parameters

    • widget: Widget

      The descendant widget of interest.

    Returns boolean

    true if the widget is a descendant, false otherwise.

dispose

  • Dispose of the widget and its descendant widgets.

    Notes

    It is unsafe to use the widget after it has been disposed.

    All calls made to this method after the first are a no-op.

    Returns void

fit

  • Post a 'fit-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

handleEvent

  • Callback on event.

    Parameters

    Returns void

hasClass

  • Test whether the widget's DOM node has the given class name.

    Parameters

    • name: string

      The class name of interest.

    Returns boolean

    true if the node has the class, false otherwise.

hide

  • Hide the widget and make it hidden to its parent widget.

    Notes

    This causes the isHidden property to be true.

    If the widget is explicitly hidden, this is a no-op.

    Returns void

Protected notifyLayout

  • Invoke the message processing routine of the widget's layout.

    Parameters

    • msg: Message

      The message to dispatch to the layout.

      Notes

      This is a no-op if the widget does not have a layout.

      This will not typically be called directly by user code.

    Returns void

Protected onActivateRequest

  • A message handler invoked on an 'activate-request' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onAfterAttach

  • A message handler invoked on an 'after-attach' message.

    Parameters

    • msg: Message

    Returns void

Protected onAfterDetach

  • A message handler invoked on an 'after-detach' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onAfterHide

  • A message handler invoked on an 'after-hide' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onAfterShow

  • A message handler invoked on an 'after-show' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onBeforeAttach

  • A message handler invoked on a 'before-attach' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onBeforeDetach

  • A message handler invoked on an 'before-detach' message.

    Parameters

    • msg: Message

    Returns void

Protected onBeforeHide

  • A message handler invoked on a 'before-hide' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onBeforeShow

  • A message handler invoked on a 'before-show' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onChildAdded

  • A message handler invoked on a 'child-added' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: ChildMessage

    Returns void

Protected onChildRemoved

  • A message handler invoked on a 'child-removed' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: ChildMessage

    Returns void

Protected onCloseRequest

  • A message handler invoked on a 'close-request' message.

    Notes

    The default implementation unparents or detaches the widget.

    Parameters

    • msg: Message

    Returns void

Protected onFitRequest

  • A message handler invoked on a 'fit-request' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onResize

  • A message handler invoked on an 'resize-request' message.

    Parameters

    • msg: ResizeMessage

    Returns void

Protected onScroll

  • Callback on scroll event

    Parameters

    • event: Event

      Scroll event

    Returns void

Protected onStateChanged

  • Callback on view model change

    Parameters

    Returns void

Protected onUpdateRequest

  • A message handler invoked on an 'update-request' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

processMessage

  • Process a message sent to the widget.

    Parameters

    • msg: Message

      The message sent to the widget.

      Notes

      Subclasses may reimplement this method as needed.

    Returns void

removeClass

  • Remove a class name from the widget's DOM node.

    Parameters

    • name: string

      The class name to remove from the node.

      Notes

      If the class name is not yet added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

scrollTo

  • Scroll to the specified offset scrollTop.

    Deprecated

    since v4 This is an internal helper. Prefer calling scrollToItem.

    Parameters

    • scrollOffset: number

      Offset to scroll

    Returns void

scrollToItem

  • Scroll to the specified item.

    By default, the list will scroll as little as possible to ensure the item is visible. You can control the alignment of the item though by specifying a second alignment parameter. Acceptable values are:

    auto (default) - Scroll as little as possible to ensure the item is visible. (If the item is already visible, it won't scroll at all.) smart - If the item is already visible (including the margin), don't scroll at all. If it is less than one viewport away, scroll so that it becomes visible (including the margin). If it is more than one viewport away, scroll so that it is centered within the list. center - Center align the item within the list. end - Align the item to the end of the list start - Align the item to the beginning of the list

    Parameters

    • index: number

      Item index to scroll to

    • Optional align: ScrollToAlign

      Type of alignment

    • Optional margin: number

      In 'smart' mode the viewport proportion to add

    Returns Promise<void>

setFlag

  • Set the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns void

setHidden

  • Show or hide the widget according to a boolean value.

    Parameters

    • hidden: boolean

      true to hide the widget, or false to show it.

      Notes

      This is a convenience method for hide() and show().

    Returns void

show

  • Show the widget and make it visible to its parent widget.

    Notes

    This causes the isHidden property to be false.

    If the widget is not explicitly hidden, this is a no-op.

    Returns void

testFlag

  • Test whether the given widget flag is set.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns boolean

toggleClass

  • Toggle a class name on the widget's DOM node.

    Parameters

    • name: string

      The class name to toggle on the node.

    • Optional force: boolean

      Whether to force add the class (true) or force remove the class (false). If not provided, the presence of the class will be toggled from its current state.

    Returns boolean

    true if the class is now present, false otherwise.

    Notes

    The class name must not contain whitespace.

update

  • Post an 'update-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc