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

Dialog window overlaying another window blocking this window until closed. More...

Inheritance diagram for WindowDialog:
WindowModal Window Container Widget

Classes

class  ButtonConfiguration
 Button configuration. More...
 
class  CloseDialog
 Close dialog with result. More...
 
class  CloseDialogCheckBox
 Close dialog with selection from Array with CheckBox. More...
 
class  CloseDialogListBox
 Close dialog with selection from ListBox. More...
 
class  CloseDialogTextModel
 Close dialog with text from TextModel. More...
 
class  CloseDialogToggleButtonGroup
 Close dialog with selection from ToggleButtonGroup. More...
 
interface  ResultListener
 Interface for result event. More...
 

Public Member Functions

void close ()
 Close dialog. More...
 
void dispose ()
 Dispose of window. More...
 
Object getResult ()
 Result to send to action listener upon closing dialog. More...
 
ResultListener getResultListener ()
 Result listener or null if not set. More...
 
WindowDialog new ()
 Create dialog window. More...
 
WindowDialog new (int x, int y, int width, int height)
 Create window with the given geometry. More...
 
void setResult (Object result)
 Set result to send to action listener upon closing dialog. More...
 
void setResultListener (ResultListener listener)
 Set result listener or null if not set. More...
 
- Public Member Functions inherited from WindowModal
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...
 
Color getBackgroundColor ()
 Background color. 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 getForegroundColor ()
 Foreground 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...
 
bool isDecorationSet ()
 Decoration is set manually. 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 onGuiThemeChanged ()
 
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 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...
 
int getPaddingBottom ()
 
int getPaddingHeight ()
 Height gain of padding. More...
 
int getPaddingLeft ()
 
int getPaddingRight ()
 
Point getPaddingSize ()
 Size gain of padding. More...
 
int getPaddingTop ()
 
int getPaddingWidth ()
 Width gain of padding. 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 onGuiThemeChanged ()
 
void onHidden (WidgetEvent event)
 Widget has been hidden. 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 (MousePointer mousePointer)
 
void setPadding (int left, int top, int right, int bottom)
 
void setPadding (int padding)
 
void setPadding (BorderSize borderSize)
 Set padding from border size. More...
 
- Public Member Functions inherited from Widget
void addDragListener (DragListener listener)
 
void addFocusListener (FocusListener listener)
 Add focus 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 dispose ()
 
Widget findFocusableWidget ()
 
Widget findLastFocusableWidget ()
 
CanvasCreator getBackgroundCanvasCreator ()
 Background canvas creator or null to use background color. More...
 
Color getBackgroundColor ()
 
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...
 
Desktop getDesktop ()
 
Point getDesktopPosition ()
 Widget position in desktop coordinates. More...
 
bool getEnabled ()
 
MousePointer getFirstMousePointer ()
 
Font getFont ()
 
Color getForegroundColor ()
 
GuiTheme getGuiTheme ()
 
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 getMinimumSizeForHeightWithBorder (int height)
 Minimum size of widget with border 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 getMinimumSizeForWidthWithBorder (int width)
 Minimum size of widget with border using reference widget width and variable height. More...
 
Point getMinimumSizeWithBorder ()
 
MousePointer getMousePointer ()
 
Container getParent ()
 
Point getPosition ()
 Position of the widget. 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...
 
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 isBackgroundColorSet ()
 
bool isFontSet ()
 
bool isForegroundColorSet ()
 
bool isGuiThemeSet ()
 
bool isMinimumSizeSet ()
 
bool isMouseInside ()
 Mouse is hovering over this widget. More...
 
bool isPointInside (Point position)
 
bool isTransformationSet ()
 
void layoutParent ()
 
Widget new ()
 
Widget new (int x, int y, int width, int height)
 
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 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 onGuiThemeChanged ()
 
void onHidden (WidgetEvent event)
 Widget has been hidden. More...
 
void onKeyPress (KeyEvent event)
 
void onKeyRelease (KeyEvent event)
 
void onKeyType (KeyEvent event)
 
void onMouseEnter (MouseEvent event)
 
void onMouseLeave (MouseEvent event)
 
void onMouseMove (MouseEvent event)
 
void onReposition (WidgetEvent event)
 Position changed. More...
 
void onResize (WidgetEvent event)
 Size changed. More...
 
void onSetBackgroundColor ()
 
void onSetFont ()
 
void onSetForegroundColor ()
 
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 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 setBackgroundColor (Color color)
 
void setBorder (Border border)
 
void setCanFocus (bool canFocus)
 
void setColorTransformation (ColorMatrix transformation)
 Set color transformation. More...
 
void setEnabled (bool enabled)
 
void setFont (Font font)
 
void setForegroundColor (Color color)
 
void setGuiTheme (GuiTheme theme)
 
void setHasFocus (bool hasFocus)
 
void setHeight (int height)
 Set height of widget. More...
 
void setMinimumSize (Point size)
 
void setMousePointer (MousePointer mousePointer)
 
void setParent (Container parent)
 
void setPosition (Point position)
 Set position of widget. More...
 
void setSize (Point size)
 Set size of widget. 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...
 

Static Public Member Functions

static WindowDialog choose (Window window, String title, String message, Image image, Array elements, int selectElement, ButtonConfiguration buttonAccept, ButtonConfiguration buttonCancel, ResultListener listener)
 Show choose message box dialog using option boxes. More...
 
static WindowDialog chooseList (Window window, String title, String message, Image image, ListModel elements, int selectElement, ListElementRenderer renderer, ButtonConfiguration buttonAccept, ButtonConfiguration buttonCancel, ResultListener listener)
 Show choose message box dialog using list box. More...
 
static Panel createButtonsAcceptCancel (ButtonConfiguration buttonAccept, ButtonConfiguration buttonCancel, ActionListener actionAccept, ActionListener actionCancel)
 Create button panel with accept/cancel buttons. More...
 
static Panel createButtonsActions (Array buttons, Array actions)
 Create button panel with buttons. More...
 
static WindowDialog input (Window window, String title, String message, Image image, String initialText, ButtonConfiguration buttonAccept, ButtonConfiguration buttonCancel, ResultListener listener)
 Request text input from user. More...
 
static WindowDialog message (Window window, String title, String message, Image image, ButtonConfiguration button, ResultListener listener)
 Show message box dialog. More...
 
static WindowDialog question (Window window, String title, String message, Image image, Array buttons, ResultListener listener)
 Show question dialog asking the user for input. More...
 
static WindowDialog selection (Window window, String title, String message, Image image, Array elements, Array selectElements, ButtonConfiguration buttonAccept, ButtonConfiguration buttonCancel, ResultListener listener)
 Show selection message box dialog using check boxes. More...
 

Additional Inherited Members

- Public Attributes inherited from WindowModal
final int CENTER_DESKTOP = 1
 Show window centered over desktop. More...
 
final int CENTER_MOUSECURSOR = 2
 Show window centered over mouse cursor. More...
 
final int CENTER_WINDOW = 0
 Show window centered over blocked window. More...
 

Detailed Description

Dialog window overlaying another window blocking this window until closed.

Extends WindowModal with support for creating typical dialog windows showing information to the user or asking for input. Once finished the an event with the result is send to the ResultListener if present. If the dialog is closed without any user input null is send as result. Otherwise the user input is send.

Member Function Documentation

§ choose()

static WindowDialog choose ( Window  window,
String  title,
String  message,
Image  image,
Array  elements,
int  selectElement,
ButtonConfiguration  buttonAccept,
ButtonConfiguration  buttonCancel,
ResultListener  listener 
)
static

Show choose message box dialog using option boxes.

Result send to listener is the index of the element in the array or -1 if the dialog has been cancelled.

Parameters
windowWindow to block while dialog window is shown.
titleTitle of the dialog window.
messageMessage to show above the option boxes.
imageto show next to the message or null to show none.
elementsArray with elements to show.
selectElementIndex of element to select initially.
buttonAcceptButton configuration for accept button or null to use "Accept".
buttonCancelButton configuration for cancel button or null to use "Cancel".
listenerListener to call closing message box.

§ chooseList()

static WindowDialog chooseList ( Window  window,
String  title,
String  message,
Image  image,
ListModel  elements,
int  selectElement,
ListElementRenderer  renderer,
ButtonConfiguration  buttonAccept,
ButtonConfiguration  buttonCancel,
ResultListener  listener 
)
static

Show choose message box dialog using list box.

Result send to listener is the index of the element in the model or -1 if the dialog has been cancelled.

Parameters
windowWindow to block while dialog window is shown.
titleTitle of the dialog window.
messageMessage to show above the option boxes.
imageImage to show next to the message or null to show none.
elementsModel with elements to show.
selectElementIndex of element to select initially.
rendererList element renderer to use.
buttonAcceptButton configuration for accept button or null to use "Accept".
buttonCancelButton configuration for cancel button or null to use "Cancel".
listenerListener to call closing message box.

§ close()

void close ( )

Close dialog.

Unblocks window and sends notification with result to listener if present.

§ createButtonsAcceptCancel()

static Panel createButtonsAcceptCancel ( ButtonConfiguration  buttonAccept,
ButtonConfiguration  buttonCancel,
ActionListener  actionAccept,
ActionListener  actionCancel 
)
static

Create button panel with accept/cancel buttons.

Helper method.

§ createButtonsActions()

static Panel createButtonsActions ( Array  buttons,
Array  actions 
)
static

Create button panel with buttons.

Helper method.

Parameters
buttonsArray of ButtonConfiguration.
actionsArray of ActionListener matching elements in buttons by index.

§ dispose()

void dispose ( )

Dispose of window.

§ getResult()

Object getResult ( )

Result to send to action listener upon closing dialog.

§ getResultListener()

ResultListener getResultListener ( )

Result listener or null if not set.

§ input()

static WindowDialog input ( Window  window,
String  title,
String  message,
Image  image,
String  initialText,
ButtonConfiguration  buttonAccept,
ButtonConfiguration  buttonCancel,
ResultListener  listener 
)
static

Request text input from user.

Result send to listener is the text string entered by the user or null if the dialog has been cancelled.

Parameters
windowWindow to block while dialog window is shown.
titleTitle of the dialog window.
messageMessage to show above the input field.
imageto show next to the message or null to show none.
textInitial text in the input field.
buttonAcceptButton configuration for accept button or null to use "Accept".
buttonCancelButton configuration for cancel button or null to use "Cancel".
listenerListener to call closing message box.

§ message()

static WindowDialog message ( Window  window,
String  title,
String  message,
Image  image,
ButtonConfiguration  button,
ResultListener  listener 
)
static

Show message box dialog.

Parameters
windowWindow to block while dialog window is shown.
titleTitle of the dialog window.
messageMessage to show.
imageto show next to the message or null to show none.
buttonButton configuration or null to show button with "Close" text.
listenerListener to call closing message box.

§ new() [1/2]

WindowDialog new ( )

Create dialog window.

§ new() [2/2]

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

Create window with the given geometry.

§ question()

static WindowDialog question ( Window  window,
String  title,
String  message,
Image  image,
Array  buttons,
ResultListener  listener 
)
static

Show question dialog asking the user for input.

Displays two or more buttons the user configurates with text and result value.

Parameters
windowWindow to block while dialog window is shown.
titleTitle of the dialog window.
messageMessage to show.
imageto show next to the message or null to show none.
buttonsArray of ButtonConfiguration of buttons to show.
listenerListener to call closing message box.

§ selection()

static WindowDialog selection ( Window  window,
String  title,
String  message,
Image  image,
Array  elements,
Array  selectElements,
ButtonConfiguration  buttonAccept,
ButtonConfiguration  buttonCancel,
ResultListener  listener 
)
static

Show selection message box dialog using check boxes.

Result send to listener is an Array of indices of selected elements in the array or null if the dialog has been cancelled.

Parameters
windowWindow to block while dialog window is shown.
titleTitle of the dialog window.
messageMessage to show above the option boxes.
imageto show next to the message or null to show none.
elementsArray with elements to show.
selectElementsArray with indices of elements to select initially.
buttonAcceptButton configuration for accept button or null to use "Accept".
buttonCancelButton configuration for cancel button or null to use "Cancel".
listenerListener to call closing message box.

§ setResult()

void setResult ( Object  result)

Set result to send to action listener upon closing dialog.

§ setResultListener()

void setResultListener ( ResultListener  listener)

Set result listener or null if not set.


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