Class ApplicationAbstract

constructor

• new Application(options?: ApplicationV1Options): Application

  Parameters

  • Optionaloptions: ApplicationV1Options = {}

    Configuration options which control how the application is rendered.

  Returns Application

appId

options

position

StaticRENDER_STATES

closing

• get closing(): boolean

  Whether the Application is currently closing.

  Returns boolean

element

• get element(): jQuery

  Return the active application element, if it currently exists in the DOM

  Returns jQuery

id

• get id(): string

  Return the CSS application ID which uniquely references this UI element

  Returns string

popOut

• get popOut(): boolean

  Control the rendering style of the application. If popOut is true, the application is rendered in its own wrapper window, otherwise only the inner app content is rendered

  Returns boolean

rendered

• get rendered(): boolean

  Return a flag for whether the Application instance is currently rendered

  Returns boolean

template

• get template(): string

  The path to the HTML template file which should be used to render the inner content of the app

  Returns string

title

• get title(): string

  An Application window should define its own title definition logic which may be dynamic depending on its data

  Returns string

StaticdefaultOptions

• get defaultOptions(): ApplicationV1Options

  Assign the default options configuration which is used by this Application class. The options and values defined in this object are merged with any provided option values which are passed to the constructor upon initialization. Application subclasses may include additional options which are specific to their usage.

  Returns ApplicationV1Options

activateListeners

• activateListeners(html: jQuery): void

  After rendering, activate event listeners which provide interactivity for the Application. This is where user-defined Application subclasses should attach their event-handling logic.

  Parameters

  • html: jQuery

  Returns void

activateTab

• activateTab(
      tabName: string,
      options?: { group: string; triggerCallback: boolean },
  ): void

  Change the currently active tab

  Parameters

  • tabName: string

    The target tab name to switch to

  • options: { group: string; triggerCallback: boolean } = {}

    Options which configure changing the tab

    • group: string

      A specific named tab group, useful if multiple sets of tabs are present

    • triggerCallback: boolean

      Whether to trigger tab-change callback functions

  Returns void

bringToFront

• bringToFront(): void

  A convenience alias for bringToTop for when operating on an object that is either an Application or an ApplicationV2

  Returns void

bringToTop

• bringToTop(): void

  Bring the application to the top of the rendering stack

  Returns void

close

• close(options?: object): Promise<void>

  Close the application and un-register references to it within UI mappings This function returns a Promise which resolves once the window closing animation concludes

  Parameters

  • Optionaloptions: object = {}

    Options which affect how the Application is closed

  Returns Promise<void>

  A Promise which resolves once the application is closed

  Fires

  closeApplication

getData

• getData(options?: object): object | Promise<object>

  An application should define the data object used to render its template. This function may either return an Object directly, or a Promise which resolves to an Object If undefined, the default implementation will return an empty object allowing only for rendering of static HTML

  Parameters

  • options: object = {}

  Returns object | Promise<object>

maximize

• maximize(): Promise<void>

  Maximize the pop-out window, expanding it to its original size Take no action for applications which are not of the pop-out variety or are already maximized

  Returns Promise<void>

  A Promise which resolves once the maximization action has completed

minimize

• minimize(): Promise<void>

  Minimize the pop-out window, collapsing it to a small tab Take no action for applications which are not of the pop-out variety or apps which are already minimized

  Returns Promise<void>

  A Promise which resolves once the minimization action has completed

render

• render(
      force?: boolean,
      options?: {
          focus?: boolean;
          height?: number;
          left?: number;
          renderContext?: string;
          renderData?: object;
          scale?: number;
          top?: number;
          width?: number;
      },
  ): Application

  Render the Application by evaluating its HTML template against the object of data provided by the getData method If the Application is rendered as a pop-out window, wrap the contained HTML in an outer frame with window controls

  Parameters

  • force: boolean = false

    Add the rendered application to the DOM if it is not already present. If false, the Application will only be re-rendered if it is already present.

  • options: {
        focus?: boolean;
        height?: number;
        left?: number;
        renderContext?: string;
        renderData?: object;
        scale?: number;
        top?: number;
        width?: number;
    } = {}

    Additional rendering options which are applied to customize the way that the Application is rendered in the DOM.

    • Optionalfocus?: boolean

      Apply focus to the application, maximizing it and bringing it to the top of the vertical stack.

    • Optionalheight?: number

      The rendered height

    • Optionalleft?: number

      The left positioning attribute

    • OptionalrenderContext?: string

      A context-providing string which suggests what event triggered the render

    • OptionalrenderData?: object

      The data change which motivated the render request

    • Optionalscale?: number

      The rendered transformation scale

    • Optionaltop?: number

      The top positioning attribute

    • Optionalwidth?: number

      The rendered width

  Returns Application

  The rendered Application instance

setPosition

• setPosition(
      position?: {
          height: string | number | null;
          left: number | null;
          scale: number | null;
          top: number | null;
          width: number | null;
      },
  ): | void
  | {
      height: number;
      left: number;
      scale: number;
      top: number;
      width: number;
  }

  Set the application position and store its new location. Returns the updated position object for the application containing the new values.

  Parameters

  • position: {
        height: string | number | null;
        left: number | null;
        scale: number | null;
        top: number | null;
        width: number | null;
    } = {}

    Positional data

    • height: string | number | null

      The application height in pixels

    • left: number | null

      The left offset position in pixels

    • scale: number | null

      The application scale as a numeric factor where 1.0 is default

    • top: number | null

      The top offset position in pixels

    • width: number | null

      The application width in pixels

  Returns
      | void
      | {
          height: number;
          left: number;
          scale: number;
          top: number;
          width: number;
      }