Hierarchy

  • DOMWidgetView
    • ToggleButtonView

Constructors

  • Public constructor.

    Parameters

    • Optional options: ViewOptions<WidgetModel, HTMLElement> & {
          options?: any;
      }

    Returns ToggleButtonView

Properties

$el: any
attributes: Record<string, any>
cid: string
className?: string
collection: Collection<any>
displayed: Promise<WidgetView>

A promise that resolves to the parent view when a child view is displayed.

el: HTMLButtonElement
id?: string
layoutPromise: Promise<any>
luminoWidget: Widget
model: WidgetModel
options: any
stylePromise: Promise<any>
tagName: string
class_map: {
    danger: string[];
    info: string[];
    primary: string[];
    success: string[];
    warning: string[];
} = ...

Type declaration

  • danger: string[]
  • info: string[]
  • primary: string[]
  • success: string[]
  • warning: string[]

Accessors

  • get pWidget(): Widget
  • Deprecated

    Use luminoWidget instead (Since 8.0).

    Returns Widget

Methods

  • Parameters

    • selector: string

    Returns JQuery<HTMLElement>

  • Parameters

    • tagName: string

    Returns void

  • Returns void

  • Handles and validates user input.

    Calling model.set will trigger all of the other views of the model to update.

    Parameters

    • event: MouseEvent

    Returns void

  • Returns void

  • Parameters

    • attrs: ObjectHash

    Returns void

  • Parameters

    • el: HTMLElement

    Returns void

  • Parameters

    • eventName: string
    • callback: EventHandler
    • Optional context: any

    Returns ToggleButtonView

  • Parameters

    • eventMap: EventMap
    • Optional context: any

    Returns ToggleButtonView

  • Create msg callbacks for a comm msg.

    Returns ICallbacks

  • Create and promise that resolves to a child view of a given model

    Type Parameters

    • VT extends DOMWidgetView<VT> = DOMWidgetView

    Parameters

    • child_model: DOMWidgetModel
    • Optional options: any

    Returns Promise<VT>

  • Type Parameters

    • VT extends WidgetView<VT> = WidgetView

    Parameters

    • child_model: WidgetModel
    • Optional options: any

    Returns Promise<VT>

  • Make an event delegation handler for the given eventName and selector and attach it to this.el. If selector is empty, the listener will be bound to this.el. If not, a new handler that will recursively traverse up the event target's DOM hierarchy looking for a node that matches the selector. If one is found, the event's delegateTarget property is set to it and the return the result of calling bound listener with the parameters given to the handler.

    This does not properly handle selectors for things like focus and blur (see https://github.com/jquery/jquery/blob/7d21f02b9ec9f655583e898350badf89165ed4d5/src/event.js#L442 for some similar exceptional cases).

    Parameters

    • eventName: string
    • listener: Function

    Returns ToggleButtonView

  • Parameters

    • eventName: string
    • selector: string
    • listener: Function

    Returns ToggleButtonView

  • Parameters

    • Optional events: _Result<EventsHash>

    Returns ToggleButtonView

  • Handle message sent to the front end.

    Used to focus or blur the widget.

    Parameters

    • content: any

    Returns void

  • Public constructor

    Parameters

    • parameters: IInitializeParameters<WidgetModel>

    Returns void

  • Parameters

    • object: any
    • events: string
    • callback: EventHandler

    Returns ToggleButtonView

  • Parameters

    • object: any
    • eventMap: EventMap

    Returns ToggleButtonView

  • Parameters

    • object: any
    • events: string
    • callback: EventHandler

    Returns ToggleButtonView

  • Parameters

    • object: any
    • eventMap: EventMap

    Returns ToggleButtonView

  • Parameters

    • Optional eventName: null | string
    • Optional callback: null | EventHandler
    • Optional context: any

    Returns ToggleButtonView

  • Parameters

    • eventName: string
    • callback: EventHandler
    • Optional context: any

    Returns ToggleButtonView

  • Parameters

    • eventMap: EventMap
    • Optional context: any

    Returns ToggleButtonView

  • Parameters

    • events: string
    • callback: EventHandler
    • Optional context: any

    Returns ToggleButtonView

  • Parameters

    • eventMap: EventMap
    • Optional context: any

    Returns ToggleButtonView

  • Parameters

    • msg: Message

    Returns void

  • Returns any

  • Send a custom msg associated with this view.

    Parameters

    • content: {}
      • Optional buffers: ArrayBuffer[] | ArrayBufferView[]

      Returns void

    • Parameters

      • element: HTMLElement | JQuery<HTMLElement>

      Returns ToggleButtonView

    • Parameters

      • layout: LayoutModel
      • Optional oldLayout: LayoutModel

      Returns void

    • Parameters

      • style: StyleModel
      • Optional oldStyle: StyleModel

      Returns void

    • Parameters

      • class_map: Dict<string[]>
      • trait_name: string
      • Optional el: HTMLElement

      Returns void

    • Parameters

      • Optional object: any
      • Optional events: string
      • Optional callback: EventHandler

      Returns ToggleButtonView

    • Returns void

    • Parameters

      • eventName: string
      • Rest ...args: any[]

      Returns ToggleButtonView

    • Parameters

      • Optional eventName: string
      • Optional callback: EventHandler
      • Optional context: any

      Returns ToggleButtonView

    • Parameters

      • eventName: string
      • Optional selector: string
      • Optional listener: Function

      Returns ToggleButtonView

    • Parameters

      • selector: string
      • Optional listener: Function

      Returns ToggleButtonView

    • Update the contents of this view

      Called when the model is changed. The model may have been changed by another view or by a state update from the back-end.

      Parameters

      • Optional options: any

      Returns void

    • Returns void

    • Returns void

    • Update the DOM classes applied to an element, default to this.el.

      Parameters

      • old_classes: string[]
      • new_classes: string[]
      • Optional el: HTMLElement

      Returns void

    • Update the DOM classes applied to the widget based on a single trait's value.

      Given a trait value classes map, this function automatically handles applying the appropriate classes to the widget element and removing classes that are no longer valid.

      Parameters

      class_map: dictionary Dictionary of trait values to class lists. Example: { success: ['alert', 'alert-success'], info: ['alert', 'alert-info'], warning: ['alert', 'alert-warning'], danger: ['alert', 'alert-danger'] }; trait_name: string Name of the trait to check the value of. el: optional DOM element handle, defaults to this.el Element that the classes are applied to.

      Parameters

      • class_map: Dict<string[]>
      • trait_name: string
      • Optional el: HTMLElement

      Returns void

    • Do not use, prefer TypeScript's extend functionality.

      Parameters

      • properties: any
      • Optional classProperties: any

      Returns any

    Generated using TypeDoc