Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TabbedWindow

Class used to create windows with multiple tabs

Hierarchy

Implements

Index

Constructors

constructor

Methods

addWindow

addWindowInstance

  • addWindowInstance(name: string, window: Window): void

close

  • close(): void

frame

  • frame(time: number): void

getAllWindows

  • getAllWindows(): Collection<Window>

getContainer

getContent

getDefaultTab

  • getDefaultTab(): number

getElements

  • getElements(): HashMap<string, Element>

getGlobalTabSize

  • getGlobalTabSize(): number

getInnerWindowHeight

  • getInnerWindowHeight(): number

getInnerWindowWidth

  • getInnerWindowWidth(): number

getStyle

getWindow

getWindowContent

getWindowForTab

getWindowNames

  • getWindowNames(): Collection<string>

getWindowTabSize

  • getWindowTabSize(): number

invalidateDrawing

  • invalidateDrawing(onCurrentThread: boolean): void
  • Forces ui drawables of the window to refresh

    Parameters

    • onCurrentThread: boolean

      if true, the drawables will be refreshed immediately, otherwise refresh event will be posted. Default value if false. Ensure you are in the UI thread if you pass true as the parameter

    Returns void

invalidateElements

  • invalidateElements(onCurrentThread: boolean): void
  • Forces ui elements of the window to refresh

    Parameters

    • onCurrentThread: boolean

      if true, the elements will be refreshed immediately, otherwise refresh event will be posted. Default value if false. Ensure you are in the UI thread if you pass true as the parameter

    Returns void

isDynamic

  • isDynamic(): boolean

isInventoryNeeded

  • isInventoryNeeded(): boolean

isOpened

  • isOpened(): boolean

moveOnTop

  • moveOnTop(name: string): void

onBackPressed

  • onBackPressed(): boolean

open

  • open(): void

refreshAll

  • refreshAll(): void

refreshWindow

  • refreshWindow(name: string): void

removeWindow

  • removeWindow(name: string): void

setBlockingBackground

  • setBlockingBackground(blockingBackground: boolean): void
  • Specifies whether the window should darken and block background. Default value is false

    Parameters

    • blockingBackground: boolean

      pass true if you want the window to block background

    Returns void

setCloseOnBackPressed

  • setCloseOnBackPressed(val: boolean): void

setContainer

setDebugEnabled

  • setDebugEnabled(enabled: boolean): void

setDefaultTab

  • setDefaultTab(tab: number): number
  • Sets default tab index

    Parameters

    • tab: number

      index of the tab to be opened by default

    Returns number

setFakeTab

  • setFakeTab(index: number, tabOverlay: ElementSet): void

setLocation

setStyle

  • Overrides style properties of the current style by the values specified in the style parameter

    Parameters

    • style: BindingsSet

      js object where keys represent binding names and values represent texture gui names

    Returns void

  • Sets new style object as current window's style. If the new style is a different object then an old one, forces window invalidation

    Parameters

    • style: Style

      Style object to be used as style for the window

    Returns void

setTab

  • Sets content of the tab

    Parameters

    • index: number

      index of the tab. There are 12 tabs available, from 0 to 11. The location of the tabs is as follows:

      0    6
      1    7
      2    8
      3    9
      4    10
      5    11
    • tabOverlay: ElementSet

      content of the tab selector

    • tabContent: WindowContent

      content of the window to be created for the tab

    • Optional isAlwaysSelected: boolean

      if true, tab is always displayed as selected. Default value is false

    Returns void

setWindowContent

Generated using TypeDoc