org.apache.pivot.wtk
Class Dialog

java.lang.Object
  extended by org.apache.pivot.wtk.Component
      extended by org.apache.pivot.wtk.Container
          extended by org.apache.pivot.wtk.Window
              extended by org.apache.pivot.wtk.Frame
                  extended by org.apache.pivot.wtk.Dialog
All Implemented Interfaces:
Iterable<Component>, Sequence<Component>, ConstrainedVisual, Visual
Direct Known Subclasses:
Alert

public class Dialog
extends Frame

Window class whose primary purpose is to facilitate interaction between an application and a user.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.pivot.wtk.Window
Window.ActionMapping, Window.ActionMappingSequence, Window.Skin
 
Nested classes/interfaces inherited from class org.apache.pivot.wtk.Component
Component.ComponentDictionary, Component.DecoratorSequence, Component.StyleDictionary, Component.UserDataDictionary
 
Nested classes/interfaces inherited from interface org.apache.pivot.collections.Sequence
Sequence.Tree
 
Constructor Summary
Dialog()
           
Dialog(Component content)
           
Dialog(String title)
           
Dialog(String title, Component content)
           
 
Method Summary
 void close()
          Closes the window and all of its owned windows.
 void close(boolean result)
           
 DialogCloseListener getDialogCloseListener()
           
 ListenerList<DialogStateListener> getDialogStateListeners()
           
 boolean getResult()
           
 boolean isClosing()
          Returns this window's closing state.
 boolean isModal()
           
 void open(Display display)
          Opens the dialog.
 void open(Display display, DialogCloseListener dialogCloseListener)
          Opens the dialog.
 void open(Window owner)
          Opens the dialog as modal over its owner.
 void open(Window owner, boolean modal)
          Opens the dialog.
 void open(Window owner, boolean modal, DialogCloseListener dialogCloseListener)
          Opens the dialog.
 void open(Window owner, DialogCloseListener dialogCloseListener)
          Opens the dialog as modal over its owner.
 
Methods inherited from class org.apache.pivot.wtk.Frame
descendantGainedFocus, descendantLostFocus, getFrameListeners, getMenuBar, remove, setMenuBar
 
Methods inherited from class org.apache.pivot.wtk.Window
align, align, descendantRemoved, getActionMappings, getActiveWindow, getClientArea, getContent, getFocusDescendant, getIcon, getOwnedWindow, getOwnedWindowCount, getOwner, getRootOwner, getTitle, getWindowActionMappingListeners, getWindowClassListeners, getWindowListeners, getWindowStateListeners, isActive, isAuxilliary, isClosed, isMaximized, isOpen, isOpening, isOwner, keyReleased, moveToBack, moveToFront, requestActive, setActive, setContent, setEnabled, setIcon, setIcon, setIcon, setMaximized, setOwner, setParent, setTitle, setVisible
 
Methods inherited from class org.apache.pivot.wtk.Container
add, containsFocus, get, getComponentAt, getContainerListeners, getContainerMouseListeners, getContextKey, getDescendantAt, getFocusTraversalPolicy, getLength, indexOf, insert, isAncestor, iterator, load, mouseClick, mouseDown, mouseMove, mouseOut, mouseUp, mouseWheel, move, paint, remove, removeAll, requestFocus, setContextKey, setFocusTraversalPolicy, setTooltip, store, transferFocus, update, validate
 
Methods inherited from class org.apache.pivot.wtk.Component
clearFocus, getAttributes, getBounds, getComponentClassListeners, getComponentDataListeners, getComponentDecoratorListeners, getComponentKeyListeners, getComponentListeners, getComponentMouseButtonListeners, getComponentMouseListeners, getComponentMouseWheelListeners, getComponents, getComponentStateListeners, getCursor, getDecoratedBounds, getDecorators, getDisplay, getDragSource, getDropTarget, getFocusedComponent, getGraphics, getHandle, getHeight, getLocation, getMaximumPreferredHeight, getMaximumPreferredWidth, getMenuHandler, getMinimumPreferredHeight, getMinimumPreferredWidth, getParent, getPreferredHeight, getPreferredHeight, getPreferredHeightLimits, getPreferredSize, getPreferredWidth, getPreferredWidth, getPreferredWidthLimits, getSize, getSkin, getStyles, getTooltipText, getUserData, getVisibleArea, getVisibleArea, getVisibleArea, getWidth, getWindow, getX, getY, installSkin, invalidate, isBlocked, isEnabled, isFocusable, isFocused, isMouseOver, isOpaque, isPreferredHeightSet, isPreferredSizeSet, isPreferredWidthSet, isShowing, isValid, isVisible, keyPressed, keyTyped, load, mapPointFromAncestor, mapPointToAncestor, mouseOver, repaint, repaint, repaint, repaint, repaint, repaint, scrollAreaToVisible, scrollAreaToVisible, setAttributes, setCursor, setCursor, setDragSource, setDropTarget, setHeight, setLocation, setLocation, setMaximumPreferredHeight, setMaximumPreferredWidth, setMenuHandler, setMinimumPreferredHeight, setMinimumPreferredWidth, setPreferredHeight, setPreferredHeightLimits, setPreferredHeightLimits, setPreferredSize, setPreferredSize, setPreferredWidth, setPreferredWidthLimits, setPreferredWidthLimits, setSize, setSize, setSkin, setStyles, setStyles, setStyles, setTooltipText, setWidth, setX, setY, store, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Dialog

public Dialog()

Dialog

public Dialog(String title)

Dialog

public Dialog(Component content)

Dialog

public Dialog(String title,
              Component content)
Method Detail

open

public final void open(Display display)
Opens the dialog.

Overrides:
open in class Window
Parameters:
display -

open

public void open(Display display,
                 DialogCloseListener dialogCloseListener)
Opens the dialog.

Parameters:
display -
dialogCloseListener -

open

public final void open(Window owner)
Opens the dialog as modal over its owner.

Overrides:
open in class Window
Parameters:
owner -

open

public final void open(Window owner,
                       boolean modal)
Opens the dialog.

Parameters:
owner -
modal -

open

public final void open(Window owner,
                       DialogCloseListener dialogCloseListener)
Opens the dialog as modal over its owner.

Parameters:
owner - The dialog's owner.
dialogCloseListener - Optional dialog close listener to be called when the dialog is closed.

open

public void open(Window owner,
                 boolean modal,
                 DialogCloseListener dialogCloseListener)
Opens the dialog.

Parameters:
owner - The dialog's owner.
modal - If true, the dialog is opened as modal, disabling its owner tree.
dialogCloseListener - Optional dialog close listener to be called when the dialog is closed.

isClosing

public boolean isClosing()
Description copied from class: Window
Returns this window's closing state.

Overrides:
isClosing in class Window
Returns:
true if the window is closing; false, otherwise.

close

public final void close()
Description copied from class: Window
Closes the window and all of its owned windows. If any owned window fails to close, this window will also fail to close.

Overrides:
close in class Window

close

public void close(boolean result)

isModal

public boolean isModal()

getDialogCloseListener

public DialogCloseListener getDialogCloseListener()

getResult

public boolean getResult()

getDialogStateListeners

public ListenerList<DialogStateListener> getDialogStateListeners()