pivot.wtk
Class Dialog

java.lang.Object
  extended by pivot.wtk.Component
      extended by pivot.wtk.Container
          extended by pivot.wtk.Window
              extended by pivot.wtk.Frame
                  extended by pivot.wtk.Dialog
All Implemented Interfaces:
java.lang.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.

Author:
gbrown

Nested Class Summary
 
Nested classes/interfaces inherited from class pivot.wtk.Window
Window.ActionDictionary
 
Nested classes/interfaces inherited from class pivot.wtk.Component
Component.Attributes, Component.ComponentDictionary, Component.DecoratorSequence, Component.StyleDictionary
 
Nested classes/interfaces inherited from interface pivot.collections.Sequence
Sequence.Search, Sequence.Sort, Sequence.Tree
 
Constructor Summary
Dialog()
           
Dialog(Component content)
           
Dialog(java.lang.String title)
           
Dialog(java.lang.String title, Component content)
           
 
Method Summary
 void close()
          Closes the window.
 void close(boolean result)
           
 DialogCloseListener getDialogCloseListener()
           
 ListenerList<DialogStateListener> getDialogStateListeners()
           
 Window getDisabledOwner()
           
 boolean getResult()
           
 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 pivot.wtk.Window
align, align, getActions, getActiveDescendant, getActiveWindow, getContent, getIcon, getOwnedWindow, getOwnedWindowCount, getOwner, getRootOwner, getTitle, getWindowClassListeners, getWindowListeners, getWindowStateListeners, isActive, isAuxilliary, isClosed, isClosing, isMaximized, isOpen, isOpening, isOwner, mouseDown, moveToBack, moveToFront, remove, setActive, setActiveDescendant, setActiveWindow, setContent, setDisplayable, setEnabled, setIcon, setIcon, setIcon, setMaximized, setOwner, setParent, setTitle
 
Methods inherited from class pivot.wtk.Container
add, containsFocus, get, getComponentAt, getContainerListeners, getContainerMouseListeners, getContextKey, getDescendantAt, getFocusTraversalPolicy, getLength, indexOf, insert, invalidate, isAncestor, isFocusable, isValid, iterator, load, load, mouseClick, mouseMove, mouseOut, mouseUp, mouseWheel, move, paint, remove, removeAll, requestFocus, setContextKey, setFocusTraversalPolicy, setTooltip, setVisible, store, store, update, validate
 
Methods inherited from class pivot.wtk.Component
clearFocus, clearFocus, finalize, getAttributes, getBounds, getComponentClassListeners, getComponentDataListeners, getComponentDecoratorListeners, getComponentDragDropListeners, getComponentKeyListeners, getComponentLayoutListeners, getComponentListeners, getComponentMouseButtonListeners, getComponentMouseListeners, getComponentMouseWheelListeners, getComponents, getComponentStateListeners, getCursor, getDecoratedBounds, getDecorators, getDisplay, getDragSource, getDropTarget, getFocusedComponent, getHandle, getHeight, getLocation, getParent, getPreferredHeight, getPreferredHeight, getPreferredSize, getPreferredWidth, getPreferredWidth, getSize, getSkin, getStyles, getTooltipText, getUserData, getVisibleArea, getVisibleArea, getVisibleArea, getWidth, getWindow, getX, getY, installSkin, isBlocked, isDisplayable, isEnabled, isFocused, isMouseOver, isPreferredHeightSet, isPreferredSizeSet, isPreferredWidthSet, isShowing, isVisible, keyPressed, keyReleased, keyTyped, mapPointFromAncestor, mapPointToAncestor, mouseOver, repaint, repaint, repaint, repaint, repaint, repaint, requestFocus, scrollAreaToVisible, scrollAreaToVisible, setAttributes, setCursor, setCursor, setDragSource, setDropTarget, setFocused, setLocation, setLocation, setPreferredHeight, setPreferredSize, setPreferredSize, setPreferredWidth, setSize, setSize, setSkin, setStyles, setStyles, setStyles, setTooltipText, setUserData, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Dialog

public Dialog()

Dialog

public Dialog(java.lang.String title)

Dialog

public Dialog(Component content)

Dialog

public Dialog(java.lang.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.

close

public final void close()
Description copied from class: Window
Closes the window. Closing a window closes all owned windows and removes the window from the display's component sequence. If the window was the active window, the active window will be cleared. If the window was the focus host, the focused component will be cleared.

Overrides:
close in class Window

close

public void close(boolean result)

isModal

public boolean isModal()

getDialogCloseListener

public DialogCloseListener getDialogCloseListener()

getDisabledOwner

public Window getDisabledOwner()

getResult

public boolean getResult()

getDialogStateListeners

public ListenerList<DialogStateListener> getDialogStateListeners()