Drag[en]gine Script Module DragonScript Script API  1.0
WindowModal Class Reference

Model window overlays another window blocking this window until closed. More...

Inheritance diagram for WindowModal:
Window Container Widget WindowDialog WindowCaptureBinding

Classes

enum  eCentering
 Centering. More...
 

Public Member Functions

Point calcWindowPosition (Window blockWindow, int placement)
 Calculate window position. More...
 
void close ()
 Close window. More...
 
void dispose ()
 Dispose of window. More...
 
Window getBlockWindow ()
 Window this window is blocking or null if not shown. More...
 
void moveAbove (Window window)
 Move window right above the given window. More...
 
void moveBelow (Window window)
 Move window right below the given window. More...
 
void moveToBottom ()
 Move window to the bottom. More...
 
void moveToTop ()
 Move window to the top. More...
 
WindowModal new ()
 Create modal window. More...
 
WindowModal new (int x, int y, int width, int height)
 Create window with the given geometry. More...
 
void show (Window blockWindow, int placement)
 Show window fit to content and block window. More...
 
void show (Window blockWindow, bool fitSize, int placement)
 Show window and block window. More...
 
void showAt (Window blockWindow, Point position)
 Show window at position and block window. More...
 
- Public Member Functions inherited from Window
void activeWidgetGrabFocus ()
 
void addWindowListener (WindowListener listener)
 Add window listener. More...
 
void centerWindow ()
 Move window to the center of the parent desktop. More...
 
void close ()
 Close window. More...
 
void dispose ()
 Dispose of widget. More...
 
void fitToContent ()
 Fit window size to content size. More...
 
bool getActivated ()
 Window is activated. More...
 
Widget getActiveWidget ()
 Active widget or null if there is none. More...
 
WindowModal getBlockingWindow ()
 Modal window blocking this window or null. More...
 
bool getCanActivate ()
 Window can be activated. More...
 
bool getCanClose ()
 Window can be closed. More...
 
bool getCanMaximize ()
 Window can be maximized. More...
 
bool getCanMinimize ()
 Window can be minimized. More...
 
bool getCanMove ()
 Window can be moved. More...
 
bool getCanReorder ()
 Window can be reordered. More...
 
bool getCanResize ()
 Window can be resized. More...
 
Decoration getDecoration ()
 Decoration of window. More...
 
Color getModalDarkenColor ()
 Darkening color while modal window is in use. More...
 
bool getProtectDecoration ()
 Protect custom set decoration. More...
 
bool getProtectModalDarkenColor ()
 Protect custom set modal window darkening color. More...
 
int getState ()
 Window state. More...
 
String getTitle ()
 Window title. More...
 
Window getWindow ()
 Window or null if this widget is not part of a window. More...
 
Point getWindowPosition ()
 Widget position in window coordinates. More...
 
void grabFocus ()
 Grab the focus if possible. More...
 
void moveAbove (Window window)
 Move window right above the given window. More...
 
void moveBelow (Window window)
 Move window right below the given window. More...
 
void moveToBottom ()
 Move window to the bottom. More...
 
void moveToTop ()
 Move window to the top. More...
 
Window new ()
 Create window. More...
 
Window new (int x, int y, int width, int height)
 Create window with the given geometry. More...
 
Widget nextFocusWidgetAfter (Widget widget)
 Find next widget in the focus cycle that can grab the focus. More...
 
void onActivated (WindowEvent event)
 Window has been activated. More...
 
void onClosing (WindowEvent event)
 Window is closing. More...
 
void onDeactivated (WindowEvent event)
 Window has been deactivated. More...
 
void onDesignerChanged ()
 Designer changed. More...
 
void onDesignerSelectorChanged ()
 Designer selector changed. More...
 
void onGuiThemeChanged ()
 Gui theme changed. More...
 
void onMaximized (WindowEvent event)
 Window has been maximized. More...
 
void onMinimized (WindowEvent event)
 Window has been minimized. More...
 
void onRestored (WindowEvent event)
 Window state switched to normal. More...
 
void onShown (WidgetEvent event)
 Widget has been shown. More...
 
void onStateChanged (StateChangeEvent event)
 State changed. More...
 
Widget prevFocusWidgetAfter (Widget widget)
 Find previous widget in the focus cycle that can grab the focus. More...
 
void removeWindowListener (WindowListener listener)
 Remove window listener. More...
 
void requestGrabFocus (Widget widget)
 Request to focus the specified widget. More...
 
void sendEventToListeners (Event event, bool sendToParent)
 Send event to all appropriate listeners for events of its kind. More...
 
void setActivated (bool activated)
 Set if window is activated. More...
 
void setBlockingWindow (WindowModal window)
 Set modal window blocking this window or null. More...
 
void setCanActivate (bool canActivate)
 Set if window can be activated. More...
 
void setCanClose (bool canClose)
 Set if window can be closed. More...
 
void setCanMaximize (bool canMaximize)
 Set if window can be maximized. More...
 
void setCanMinimize (bool canMinimize)
 Set if window can be minimized. More...
 
void setCanMove (bool canMove)
 Set if window can be moved. More...
 
void setCanReorder (bool canReorder)
 Set if window can be reordered. More...
 
void setCanResize (bool canResize)
 Set window can be resized. More...
 
void setDecoration (Decoration decoration)
 Set decoration of window. More...
 
void setModalDarkenColor (Color color)
 Set darkening color while modal window is in use. More...
 
void setProtectDecoration (bool protect)
 Set protect custom set decoration. More...
 
void setProtectModalDarkenColor (bool protect)
 Set protect custom set modal window darkening color. More...
 
void setState (int state)
 Set window state. More...
 
void setTitle (String title)
 Set window title. More...
 
void updateCanvasGeometry ()
 
- Public Member Functions inherited from Container
void addWidget (Widget widget)
 
void addWidget (Widget widget, Object settings)
 
bool allowsChildGrabFocus ()
 
void dispose ()
 
void doLayout ()
 
Widget findLastFocusableWidget ()
 
void forEachWidget (Block ablock)
 
bool getAutoVisibleChildren ()
 
bool getBlockLayout ()
 Block layout calls. More...
 
int getContainerHeight ()
 
Point getContainerSize ()
 
int getContainerWidth ()
 
Layout getLayout ()
 
Point getMinimumSize ()
 
Point getMinimumSizeForHeight (int height)
 Minimum size of widget using reference widget height and variable width. More...
 
Point getMinimumSizeForWidth (int width)
 Minimum size of widget using reference widget width and variable height. More...
 
Widget getWidget (int index)
 
Widget getWidgetAt (Point position)
 Widget at coordinates or null if not found. More...
 
int getWidgetCount ()
 
void giveUpFocus ()
 
bool hasFocusWidget ()
 Focus widget is inside container somewhere. More...
 
bool hasWidget (Widget widget)
 
int indexOfWidget (Widget widget)
 
bool isChildVisible (Widget child)
 
bool isMouseInside ()
 Mouse is hovering over this widget. More...
 
void layoutParent ()
 
void moveWidget (Widget widget, int newPosition)
 
Container new ()
 
Container new (int x, int y, int width, int height)
 
Widget nextFocusWidgetAfter (Widget widget)
 Find next widget in the focus cycle that can grab the focus. More...
 
void notifyChildrenParentStateChanged ()
 Notify children about parent state change. More...
 
void onGuiThemeChanged ()
 
void onHidden (WidgetEvent event)
 Widget has been hidden. More...
 
void onPaddingChanged ()
 Padding changed. More...
 
void onParentStateChanged ()
 Parent state changed. More...
 
void onResize (WidgetEvent event)
 Size changed. More...
 
void onStateChanged (StateChangeEvent event)
 State changed. More...
 
Widget prevFocusWidgetAfter (Widget widget)
 Find previous widget in the focus cycle that can grab the focus. More...
 
void removeAllWidgets ()
 
void removeWidget (Widget widget)
 
void reorderChildCanvas ()
 
bool requestCaptureMouse (Widget widget)
 
bool requestReleaseMouse (Widget widget)
 
void runWhileBlockingLayout (Block ablock)
 Run block while layouting is blocked. More...
 
void setAutoVisibleChildren (bool autoVisible)
 
void setBlockLayout (bool blockLayout)
 Set block layout calls. More...
 
void setLayout (Layout layout)
 
void setMousePointer (MousePointerFactory mousePointer)
 Set mouse pointer to use. More...
 
- Public Member Functions inherited from Widget
void addDragListener (DragListener listener)
 
void addFocusListener (FocusListener listener)
 Add focus listener. More...
 
void addGamepadListener (GamepadListener listener)
 Add gamepad listener. More...
 
void addKeyListener (KeyListener listener)
 
void addMouseListener (MouseListener listener)
 
void addStateChangeListener (StateChangeListener listener)
 Add state change listener. More...
 
void addWidgetListener (WidgetListener listener)
 Add widget listener. More...
 
bool canGrabFullFocus ()
 
void captureMouse ()
 
void design ()
 Design widget using WidgetDesigner. More...
 
void dispose ()
 
Widget findFocusableWidget ()
 
Widget findLastFocusableWidget ()
 
CanvasCreator getBackgroundCanvasCreator ()
 Background canvas creator or null to use background color. More...
 
Border getBorder ()
 
BorderSize getBorderSize ()
 
RectArea getBoundary ()
 Rectangulare boundary of the widget. More...
 
RectArea getBoundaryWithBorder ()
 Rectangulare boundary of the widget including border. More...
 
bool getCanFocus ()
 
CanvasView getCanvasBackground ()
 
CanvasView getCanvasContent ()
 
CanvasView getCanvasWidget ()
 
ColorMatrix getColorTransformation ()
 Color transformation. More...
 
WidgetDesigner getDesigner ()
 Designer. More...
 
String getDesignerSelector ()
 Designer selector. More...
 
Desktop getDesktop ()
 
Point getDesktopPosition ()
 Widget position in desktop coordinates. More...
 
bool getEnabled ()
 
MousePointerFactory getFirstMousePointer ()
 First assigned mouse pointer. More...
 
Font getFont ()
 
GuiTheme getGuiTheme ()
 Gui theme to use for this widget. More...
 
bool getHasFocus ()
 
int getHeight ()
 Height of widget. More...
 
RangeModel getHorizontalRangeModel ()
 Horizontal range model for viewports to synchronize the horizontal scrollbar. More...
 
Point getMinimumSize ()
 
Point getMinimumSizeForHeight (int height)
 Minimum size of widget using reference widget height and variable width. More...
 
Point getMinimumSizeForWidth (int width)
 Minimum size of widget using reference widget width and variable height. More...
 
Point getMinimumSizeWithBorder ()
 
Point getMinimumSizeWithBorderForHeight (int height)
 Minimum size of widget with border using reference height. More...
 
Point getMinimumSizeWithBorderForWidth (int width)
 Minimum size of widget with border for reference width. More...
 
MousePointerFactory getMousePointer ()
 Mouse pointer to use. More...
 
BorderSize getPadding ()
 Padding. More...
 
Container getParent ()
 
Point getPosition ()
 Position of the widget. More...
 
bool getProtectBackgroundCanvasCreator ()
 Protect custom set background canvas creator. More...
 
bool getProtectBorder ()
 Protect custom set border. More...
 
bool getProtectFont ()
 Protect custom set font. More...
 
bool getProtectMinimumSize ()
 Protect custom set minimumsize. More...
 
bool getProtectMousePointer ()
 Protect custom set mouse pointer. More...
 
bool getProtectPadding ()
 Protect custom set padding. More...
 
bool getProtectTextColor ()
 Protect custom set text color. More...
 
Point getRelativePosition (Container parent)
 Widget position in parent widget coordinates. More...
 
Point getScreenPosition ()
 Widget position in screen coordinates. More...
 
RectArea getScreenRectArea ()
 
Point getSetMinimumSize ()
 
Point getSize ()
 Size of the widget. More...
 
Color getTextColor ()
 Text color. More...
 
String getThemeSelector ()
 Gui theme selector or null if not used. More...
 
float getTotalTransparency ()
 
TexMatrix2 getTransformation ()
 
float getTransparency ()
 
RangeModel getVerticalRangeModel ()
 Vertical range model for viewports to synchronize the vertical scrollbar. More...
 
bool getVisible ()
 
Widget getWidgetAt (Point position)
 Widget at coordinates or null if not found. More...
 
int getWidth ()
 Width of widget. More...
 
Window getWindow ()
 
Point getWindowPosition ()
 Widget position in window coordinates. More...
 
int getX ()
 X position of widget. More...
 
int getY ()
 Y position of widget. More...
 
void grabFocus ()
 
bool hasParent (Container container)
 
bool isDesignerSet ()
 Custom designer is set. More...
 
bool isFullEnabled ()
 Widget and all parent widgets are enabled. More...
 
bool isGuiThemeSet ()
 
bool isMinimumSizeSet ()
 
bool isMouseInside ()
 Mouse is hovering over this widget. More...
 
bool isPointInside (Point position)
 
bool isTransformationSet ()
 
void layoutParent ()
 
Widget new ()
 Create widget. More...
 
Widget new (int x, int y, int width, int height)
 Create widget with initial location and size. More...
 
Widget nextFocusWidget ()
 Find next widget in the focus cycle that can grab the focus. More...
 
void notifyBorderParametersChanged ()
 
void onButtonPress (MouseEvent event)
 
void onButtonRelease (MouseEvent event)
 
void onDesignerChanged ()
 Designer changed. More...
 
void onDesignerSelectorChanged ()
 Designer selector changed. More...
 
void onDispose (WidgetEvent event)
 Window is disposing. More...
 
void onDragDrop (DragEvent event)
 
void onDragEnter (DragEvent event)
 
void onDragLeave (DragEvent event)
 
void onDragOver (DragEvent event)
 
void onFocusLost (FocusEvent event)
 Widget lost focus. More...
 
void onFocusReceived (FocusEvent event)
 Widget received focus. More...
 
void onGamepadAxisMoved (GamepadEvent event)
 Gamepad axis has been moved. More...
 
void onGamepadButtonPressed (GamepadEvent event)
 Gamepad button has been pressed. More...
 
void onGamepadButtonReleased (GamepadEvent event)
 Gamepad button has been released. More...
 
void onGuiThemeChanged ()
 
void onHidden (WidgetEvent event)
 Widget has been hidden. More...
 
void onKeyPress (KeyEvent event)
 
void onKeyRelease (KeyEvent event)
 
void onMouseEnter (MouseEvent event)
 
void onMouseLeave (MouseEvent event)
 
void onMouseMove (MouseEvent event)
 
void onMouseWheel (MouseEvent event)
 Mouse wheel has moved. More...
 
void onPaddingChanged ()
 Padding changed. More...
 
void onParentStateChanged ()
 Parent state changed. More...
 
void onReposition (WidgetEvent event)
 Position changed. More...
 
void onResize (WidgetEvent event)
 Size changed. More...
 
void onSetBackgroundColor ()
 
void onSetFont ()
 
void onSetTextColor ()
 Text color changed. More...
 
void onShown (WidgetEvent event)
 Widget has been shown. More...
 
void onStateChanged (StateChangeEvent event)
 State changed. More...
 
Widget prevFocusWidget ()
 Find previous widget in the focus cycle that can grab the focus. More...
 
void processEvent (Event event)
 
void releaseMouse ()
 
void removeDragListener (DragListener listener)
 
void removeFocusListener (FocusListener listener)
 Remove focus listener. More...
 
void removeGamepadListener (GamepadListener listener)
 
void removeKeyListener (KeyListener listener)
 
void removeMouseListener (MouseListener listener)
 
void removeStateChangeListener (StateChangeListener listener)
 Remove state change listener. More...
 
void removeWidgetListener (WidgetListener listener)
 Remove widget listener. More...
 
void requestGrabFocus (Widget widget)
 
void sendEvent (Event event)
 
void sendEventToListeners (Event event, bool sendToParent)
 Send event to all appropriate listeners for events of its kind. More...
 
void setBackgroundCanvasCreator (CanvasCreator creator)
 Set background canvas creator or null to use background color. More...
 
void setBorder (Border border)
 
void setCanFocus (bool canFocus)
 
void setColorTransformation (ColorMatrix transformation)
 Set color transformation. More...
 
void setDesigner (WidgetDesigner designer)
 Set designer. More...
 
void setDesignerSelector (String selector)
 Set designer selector. More...
 
void setEnabled (bool enabled)
 
void setFont (Font font)
 
void setGuiTheme (GuiTheme theme)
 
void setHasFocus (bool hasFocus)
 
void setHeight (int height)
 Set height of widget. More...
 
void setMinimumSize (Point size)
 
void setMousePointer (MousePointerFactory mousePointer)
 Set mouse pointer to use. More...
 
void setPadding (BorderSize padding)
 Set padding. More...
 
void setParent (Container parent)
 
void setPosition (Point position)
 Set position of widget. More...
 
void setProtectBackgroundCanvasCreator (bool protect)
 Set protect custom set background canvas creator. More...
 
void setProtectBorder (bool protect)
 Set protect custom set border. More...
 
void setProtectFont (bool protect)
 Set protect custom set font. More...
 
void setProtectMinimumSize (bool protect)
 Set protect custom set minimumsize. More...
 
void setProtectMousePointer (bool protect)
 Set protect custom set mouse pointer. More...
 
void setProtectPadding (bool protect)
 Set protect custom set padding. More...
 
void setProtectTextColor (bool protect)
 Set protect custom set text color. More...
 
void setSize (Point size)
 Set size of widget. More...
 
void setTextColor (Color color)
 Set text color. More...
 
void setThemeSelector (String selector)
 Set gui theme selector or null if not used. More...
 
void setTransformation (TexMatrix2 transformation)
 
void setTransparency (float transparency)
 
void setVisible (bool visible)
 
void setWidth (int width)
 Set width of widget. More...
 
void setX (int x)
 Set X position of widget. More...
 
void setY (int y)
 Set Y Position of widget. More...
 
void stopRepeatEventTimer ()
 
void updateCanvasBackground ()
 Update background canvas content. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Window
void setDecorationFromDesigner ()
 Set decoration from designer if not protected. More...
 
- Protected Member Functions inherited from Widget
WidgetDesigner getDesignerFromTheme ()
 Get designer from gui theme. More...
 

Detailed Description

Model window overlays another window blocking this window until closed.

Modal windows are mainly used for dialog type windows asking input from the user or showing short information to acknowledge. Modal windows block another window as long as they are visible. The blocked window is disabled and a color matrix applied to tone down the entire window giving a visual cue to the user the window is blocked.

This is the base class of modal windows implementing the required behavior. For convenience WindowDialog extends WindowModal with typical dialog building and input returning support. Extend WindowModal for all other situations.

The modal window is shown without blocking command flow. To react to the modal window closing add an WindowListener catching WindowEvent.ID_WINDOW_CLOSING event or overwrite onClosing() if subclassing.

Member Function Documentation

◆ calcWindowPosition()

Point calcWindowPosition ( Window  blockWindow,
int  placement 
)

Calculate window position.

Parameters
blockWindowRefertence window for position calculation.
placementPlacement of the window. One of CENTER_*.

◆ close()

void close ( )

Close window.

Unblocks window.

◆ dispose()

void dispose ( )

Dispose of window.

◆ getBlockWindow()

Window getBlockWindow ( )

Window this window is blocking or null if not shown.

◆ moveAbove()

void moveAbove ( Window  window)

Move window right above the given window.

Ensure blocked window is moved right underneath.

◆ moveBelow()

void moveBelow ( Window  window)

Move window right below the given window.

Ensure blocked window is moved right underneath.

◆ moveToBottom()

void moveToBottom ( )

Move window to the bottom.

Ensure blocked window is moved right underneath.

◆ moveToTop()

void moveToTop ( )

Move window to the top.

Ensure blocked window is moved right underneath.

◆ new() [1/2]

WindowModal new ( )

Create modal window.

◆ new() [2/2]

WindowModal new ( int  x,
int  y,
int  width,
int  height 
)

Create window with the given geometry.

◆ show() [1/2]

void show ( Window  blockWindow,
int  placement 
)

Show window fit to content and block window.

Window is centered over blocked window.

Parameters
blockWindowWindow to block while modal window is shown.
placementPlacement of the window. One of CENTER_*.

◆ show() [2/2]

void show ( Window  blockWindow,
bool  fitSize,
int  placement 
)

Show window and block window.

Window is centered over blocked window.

Parameters
blockWindowWindow to block while modal window is shown.
fitSizeFit window to content size
placementPlacement of the window. One of CENTER_*.

◆ showAt()

void showAt ( Window  blockWindow,
Point  position 
)

Show window at position and block window.

Window is centered over blocked window.

Parameters
blockWindowWindow to block while modal window is shown.
positionPosition to show window at.

The documentation for this class was generated from the following file: