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.IconImageSequence, Window.Skin
 
Nested classes/interfaces inherited from class org.apache.pivot.wtk.Container
Container.EDT_Checker
 
Nested classes/interfaces inherited from class org.apache.pivot.wtk.Component
Component.DecoratorSequence, Component.StyleDictionary, Component.UserDataDictionary
 
Nested classes/interfaces inherited from interface org.apache.pivot.collections.Sequence
Sequence.Tree<T>
 
Constructor Summary
Dialog()
           
Dialog(boolean modal)
           
Dialog(Component content)
           
Dialog(Component content, boolean modal)
           
Dialog(String title)
           
Dialog(String title, boolean modal)
           
Dialog(String title, Component content)
           
Dialog(String title, Component content, boolean modal)
           
 
Method Summary
 void close()
          Closes the window and all of its owned windows.
 void close(boolean resultArgument)
           
 DialogCloseListener getDialogCloseListener()
           
 ListenerList<DialogListener> getDialogListeners()
           
 ListenerList<DialogStateListener> getDialogStateListeners()
           
 boolean getResult()
           
 boolean isClosing()
          Returns this window's closing state.
 boolean isModal()
           
 void open(Display display, DialogCloseListener dialogCloseListenerArgument)
          Opens the dialog.
 void open(Display display, Window owner)
          Opens the dialog.
 void open(Display display, Window owner, DialogCloseListener dialogCloseListenerArgument)
          Opens the dialog.
 void open(Window owner, DialogCloseListener dialogCloseListenerArgument)
          Opens the dialog.
 void setModal(boolean modal)
           
 
Methods inherited from class org.apache.pivot.wtk.Frame
descendantGainedFocus, descendantLostFocus, getFrameListeners, getMenuBar, moveToFront, remove, setMenuBar
 
Methods inherited from class org.apache.pivot.wtk.Window
align, align, clearActive, clearFocusDescendant, descendantRemoved, getActionMappings, getActiveWindow, getClientArea, getContent, getFocusDescendant, getIcons, getOwnedWindow, getOwnedWindowCount, getOwner, getRootOwner, getTitle, getWindowActionMappingListeners, getWindowClassListeners, getWindowListeners, getWindowStateListeners, isActive, isBottomMost, isClosed, isMaximized, isOpen, isOpening, isOwner, isTopMost, keyPressed, moveToBack, open, open, requestActive, setActive, setContent, setEnabled, setIcon, setIcon, setMaximized, setParent, setTitle, setVisible
 
Methods inherited from class org.apache.pivot.wtk.Container
add, assertEventDispatchThread, assertEventDispatchThread, clear, containsFocus, descendantAdded, get, getComponentAt, getContainerListeners, getContainerMouseListeners, getDescendantAt, getFocusTraversalPolicy, getGraphics, getLength, getNamedComponent, indexOf, insert, invalidate, isAncestor, isDoubleBuffered, iterator, layout, load, mouseClick, mouseDown, mouseMove, mouseOut, mouseUp, mouseWheel, move, paint, remove, removeAll, repaint, requestFocus, setDoubleBuffered, setEventDispatchThreadChecker, setFocusTraversalPolicy, store, transferFocus, update
 
Methods inherited from class org.apache.pivot.wtk.Component
clearFocus, contains, getAncestor, getAncestor, getAttribute, getAutomationID, getBaseline, getBaseline, getBounds, getComponentClassListeners, getComponentDataListeners, getComponentDecoratorListeners, getComponentKeyListeners, getComponentListeners, getComponentMouseButtonListeners, getComponentMouseListeners, getComponentMouseWheelListeners, getComponentStateListeners, getComponentStyleListeners, getComponentTooltipListeners, getCursor, getDecoratedBounds, getDecorators, getDisplay, getDragSource, getDropTarget, getFocusedComponent, getHeight, getHeightLimits, getLocation, getMaximumHeight, getMaximumWidth, getMenuHandler, getMinimumHeight, getMinimumWidth, getMouseLocation, getName, getNamedStyles, getParent, getPreferredHeight, getPreferredHeight, getPreferredSize, getPreferredWidth, getPreferredWidth, getSize, getSkin, getStyles, getTooltipDelay, getTooltipText, getTooltipWrapText, getTypedStyles, getUserData, getVisibleArea, getVisibleArea, getVisibleArea, getWidth, getWidthLimits, getWindow, getX, getY, indexBoundsCheck, installSkin, isBlocked, isEnabled, isFocusable, isFocused, isMouseOver, isOpaque, isPreferredHeightSet, isPreferredSizeSet, isPreferredWidthSet, isShowing, isValid, isVisible, keyReleased, keyTyped, mapPointFromAncestor, mapPointFromAncestor, mapPointToAncestor, mapPointToAncestor, mouseOver, reenterMouse, repaint, repaint, repaint, repaint, repaint, scrollAreaToVisible, scrollAreaToVisible, setAttribute, setAutomationID, setCursor, setDragSource, setDropTarget, setFocused, setHeight, setHeightLimits, setHeightLimits, setLocation, setLocation, setMaximumHeight, setMaximumWidth, setMenuHandler, setMinimumHeight, setMinimumWidth, setName, setPreferredHeight, setPreferredSize, setPreferredSize, setPreferredWidth, setSize, setSize, setSkin, setStyleName, setStyleNames, setStyleNames, setStyles, setStyles, setTooltipDelay, setTooltipText, setTooltipWrapText, setWidth, setWidthLimits, setWidthLimits, setX, setY, toString, transferFocus, validate
 
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(boolean modal)

Dialog

public Dialog(String title)

Dialog

public Dialog(String title,
              boolean modal)

Dialog

public Dialog(Component content)

Dialog

public Dialog(Component content,
              boolean modal)

Dialog

public Dialog(String title,
              Component content)

Dialog

public Dialog(String title,
              Component content,
              boolean modal)
Method Detail

isModal

public boolean isModal()

setModal

public void setModal(boolean modal)

open

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

Overrides:
open in class Window
Parameters:
display - The display on which the dialog will be opened.
owner - The window's owner. The dialog will be modal over this window.

open

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

Parameters:
display - The display on which the dialog will be opened.
dialogCloseListenerArgument - A listener that will be called when the dialog is closed.

open

public final void open(Window owner,
                       DialogCloseListener dialogCloseListenerArgument)
Opens the dialog.

Parameters:
owner - The window's owner. The dialog will be modal over this window.
dialogCloseListenerArgument - A listener that will be called when the dialog is closed.

open

public void open(Display display,
                 Window owner,
                 DialogCloseListener dialogCloseListenerArgument)
Opens the dialog.

Parameters:
display - The display on which the dialog will be opened.
owner - The window's owner, or null if the window has no owner. Required if the dialog is modal.
dialogCloseListenerArgument - A listener that will 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 resultArgument)

getDialogCloseListener

public DialogCloseListener getDialogCloseListener()

getResult

public boolean getResult()

getDialogListeners

public ListenerList<DialogListener> getDialogListeners()

getDialogStateListeners

public ListenerList<DialogStateListener> getDialogStateListeners()