GaldurWindow
classclient onlysince 0.1.0com.galdurstudio.galdurui.api.window.GaldurWindow
A screen described by a mod's code: title, texts, buttons, checkboxes, lists, tabs...
Created with GaldurLib.createWindow(). It only holds
the description of the screen; layout, theme and rendering are handled by Galdur UI, and no
coordinate ever needs computing.
The add...(...) methods inherited from ElementContainer add elements top to
bottom, in call order. An element added while the window is shown appears on the next frame
(call on the client thread).
MEMBERS · 26
Constructors 1
GaldurWindow
Creates an empty window. Prefer GaldurLib.createWindow().
Methods 13
open
Shows the window. No effect if it is already open or opening.
The screen shown until then is remembered: close() and Escape go back to it.
close
Closes the window and goes back to the previous screen, exactly like Escape. No effect when it is closed.
isOpen
RETURNSboolean — true if the window is on screen or opening
addTabs
2 overloadsAdds a left-aligned tab row at the end of the window and returns its handle; see
addTabs() to centre it.
Each tab has its own content, filled like a window. Only the active tab's content is shown, below the row; the window keeps the size of the largest content, so it does not resize when switching tabs.
PARAMETERS
true to centre it in the window, false to align it leftRETURNSTabsHandle — the tabs handle, used to add tabs and pick the active one
Adds a left-aligned line of text at the end; see addText() to
centre it.
PARAMETERS
true to centre it, false to align it leftRETURNSElementHandle — the element's handle (disable, hide, tooltip)
Adds a left-aligned title at the end; see addTitle() to centre
it.
A title differs from plain text by its style. It usually comes first, but nothing enforces it: elements stay in call order.
PARAMETERS
true to centre it, false to align it leftRETURNSElementHandle — the element's handle (disable, hide, tooltip)
Adds a left-aligned button at the end; see addButton()
to centre it.
The action runs every time the button is activated, by mouse or keyboard.
PARAMETERS
true to centre it, false to align it leftRETURNSElementHandle — the element's handle (disable, hide, tooltip)
Adds a left-aligned icon button showing an item at the end; see
addIconButton() to centre it.
The label is not drawn on the button: it is the tooltip and the narrated text. A tooltip
set on the handle replaces it. For several icons side by side, use a row
(RowHandle.addIconButton()).
PARAMETERS
true to centre it, false to align it leftRETURNSElementHandle — the element's handle (disable, hide, tooltip)
Adds a left-aligned checkbox at the end and returns its handle; see
addCheckbox() to centre it.
The handle reads and changes the state, reports changes and, like any
ElementHandle, disables, hides or gives a tooltip to the checkbox.
PARAMETERS
true if the checkbox is checked on opentrue to centre it, false to align it leftRETURNSCheckboxHandle — the checkbox handle
Adds a left-aligned row at the end and returns its handle, to place elements side by side;
see addRow() to centre it.
PARAMETERS
true to centre it, false to align it leftRETURNSRowHandle — the row handle, used to add elements to it
Adds a left-aligned scrolling list at the end and returns its handle, which holds its lines
and selection; see addList() to centre it.
PARAMETERS
true to centre it, false to align it leftRETURNSListHandle — the list handle
Adds a left-aligned search field at the end and returns its handle, which holds the typed
text; see addSearch() to centre it.
PARAMETERS
true to centre it, false to align it leftRETURNSSearchHandle — the field handle
Adds a left-aligned progress bar at the end and returns its handle, which holds its
progress and text; see addProgress() to centre it.
PARAMETERS
null for none; it also sets the bar width
(at least 100 pixels)true to centre it, false to align it leftRETURNSProgressHandle — the bar handle, empty at first