Class WindowGroup

constructor

• new WindowGroup(): WindowGroup

• Constructs new UI.WindowGroup instance.

  Returns WindowGroup

addWindow

• addWindow(name, content): Window

• Creates a new window using provided description and adds it to the group.

  Parameters

  • name: string

    window name
  • content: WindowContent

    window description object

  Returns Window

  Created UI.Window object.

addWindowInstance

• addWindowInstance(name, window): void

• Adds window instance with specified name to the group.

  Parameters

  • name: string

    window name
  • window: IWindow

    window to be added to the group

  Returns void

close

• close(): void

• Closes window without container. Use only if the window was opened without container.

  Returns void

frame

• frame(time): void

• Called up to 66 times a second to update window's content.

  Parameters

  • time: number

    current time in milliseconds

  Returns void

getAllWindows

• getAllWindows(): Collection<Window>

• Returns Collection<Window>

  Collection object containing all the UI.Windows in the group.

getContainer

• getContainer(): UiAbstractContainer

• Returns UiAbstractContainer

  Currently UI.Container that was used to open this window or null, if the window wasn't opened in container.

getContent

• getContent(): WindowContent

• Returns WindowContent

  null for WindowGroup.

getElements

• getElements(): HashMap<string, IElement>

• Gets all the elements in the window.

  Returns HashMap<string, IElement>

  Hashes containing string element name as keys and element instances as values.

getStyle

• getStyle(): Style

• Returns Style

  Object containing current style of the window.

getWindow

• getWindow(name): Window

• Parameters

  • name: string

    window name

  Returns Window

  Window from the group by it's name or null if no window with such a name was added.

getWindowContent

• getWindowContent(name): WindowContent

• Parameters

  • name: string

    window name

  Returns WindowContent

  Window's description object if a window with specified name exists or null otherwise.

getWindowNames

• getWindowNames(): Collection<string>

• Returns Collection<string>

  Collection object containing string names of the windows in the group.

invalidateAllContent

• invalidateAllContent(): void

• Returns void

invalidateDrawing

• invalidateDrawing(onCurrentThread): 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; ensure you are in the UI thread if you pass true as the parameter

  Returns void

  Default

  onCurrentThread: false
  Copy

invalidateElements

• invalidateElements(onCurrentThread): void

• Forces ui elements of the window to refresh.

  Parameters

  • onCurrentThread: boolean

    if true, the drawables will be refreshed immediately, otherwise refresh event will be posted; ensure you are in the UI thread if you pass true as the parameter

  Returns void

  Default

  onCurrentThread: false
  Copy

isDynamic

• isDynamic(): boolean

• Returns boolean

  true if the window can change it's contents position.

isInventoryNeeded

• isInventoryNeeded(): boolean

• Returns boolean

  true if the window has an inventory that should be updated.

isOpened

• isOpened(): boolean

• Returns boolean

  true if the window is opened, false otherwise.

moveOnTop

• moveOnTop(name): void

• Moves window with specified name to the top of the group.

  Parameters

  • name: string

    window name

  Returns void

onBackPressed

• onBackPressed(): boolean

• Returns boolean

  Whether the window group can be closed on pressing back navigation button.

open

• open(): void

• Opens window without container.

  Returns void

refreshAll

• refreshAll(): void

• Forces refresh for all windows.

  Returns void

refreshWindow

• refreshWindow(name): void

• Forces window refresh by it's name.

  Parameters

  • name: string

    name of the window to refresh

  Returns void

removeWindow

• removeWindow(name): void

• Removes window from group by it's name.

  Parameters

  • name: string

    window name

  Returns void

setBlockingBackground

• setBlockingBackground(bb): void

• Parameters

  • bb: boolean

  Returns void

setCloseOnBackPressed

• setCloseOnBackPressed(val): void

• Gives the property to be closed on pressing back navigation button to the given window group.

  Parameters

  • val: boolean

  Returns void

setContainer

• setContainer(container): void

• Sets container for the current window. Be careful when calling it manually. You should prefer opening the window via UI.Container.openAs call.

  Parameters

  • container: UiAbstractContainer

    UI.Container to be associated with current window or null to associate no container with current window.

  Returns void

setDebugEnabled

• setDebugEnabled(enabled): void

• Turns debug mode for the window on and off.

  Parameters

  • enabled: boolean

    if true, additional debug information will be drawn on the window canvas

  Returns void

setStyle

• setStyle(style): void

• Parameters

  • style: Style

  Returns void

• setStyle(style): void

• Parameters

  • style: BindingSet

  Returns void

setWindowContent

• setWindowContent(name, content): void

• Sets content for the window by it's name.

  Parameters

  • name: string

    window name
  • content: WindowContent

    content object

  Returns void

closeOnBackPressed