Class Inspector

Offers a simple means to inspect and change the values in some object or set of objects.

Hierarchy (view full)

Methods

bind ensureContext fire getListener getValue hasPendingChanges isSuspendEvents persist redraw setSuspendEvents setValue silently unbind

Methods

bind

  • bind<T>(event, listener, insertAtStart?): EventGenerator

  • Bind an event listener. This method can be used with a type parameter by call sites; although it's not necessary it can be helpful to use this to ensure you've thought about what the payload to your event handler is going to be.

    Type Parameters

    • T = any

    Parameters

    • event: string

      Name of the event(s) to bind to.

    • listener: ((a: T, e?: any) => any)

      Function to bind to the given event(s)

        • (a, e?): any

        • Parameters

          • a: T
          • Optionale: any

          Returns any

    • OptionalinsertAtStart: boolean

      Whether or not to insert this listener at the head of the listener queue. Defaults to false.

    Returns EventGenerator

ensureContext

  • ensureContext<T>(name, generator): T

  • Either get the named object from the context, or create it, set it, and then return it.

    Type Parameters

    • T

    Parameters

    • name: string
    • generator: (() => T)
        • (): T

        • Returns T

    Returns T

fire

  • fire<T>(event, value?, originalEvent?): any

  • Fire the named event.

    Type Parameters

    • T

    Parameters

    • event: string

      Event to fire

    • Optionalvalue: T

      Value to pass to event handlers

    • OptionaloriginalEvent: Event

      Optional original event that caused this event to be fired.

    Returns any

getListener

getValue

  • getValue(key): string

  • Gets the current value for the given key, may be null.

    Parameters

    • key: string

    Returns string

hasPendingChanges

  • hasPendingChanges(): boolean

  • Returns whether or not there are unsaved changes.

    Returns boolean

isSuspendEvents

persist

  • persist(): number

  • Persist any pending updates to the toolkit, then clear the list of pending updates. Returns the count of the number of changes made.

    Returns number

redraw

  • redraw(): void

  • Redraw the inspector.

    Returns void

setSuspendEvents

setValue

  • setValue(key, value, repaintAfterwards?): void

  • For subclasses/wrapper classes to use.

    Parameters

    • key: string
    • value: any
    • OptionalrepaintAfterwards: boolean

    Returns void

silently

unbind

  • unbind(eventOrListener?, listener?): EventGenerator

  • Unbind the given event listener, or all listeners. If you call this method with no arguments then all event listeners are unbound.

    Parameters

    • OptionaleventOrListener: string | Function

      Either an event name, or an event handler function

    • Optionallistener: Function

      If eventOrListener is defined, this is the event handler to unbind.

    Returns EventGenerator

Settings

Member Visibility

On This Page

Methods
Version :