org.apache.pivot.wtk
Class Prompt

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.Sheet
                  extended by org.apache.pivot.wtk.Prompt
All Implemented Interfaces:
Iterable<Component>, Sequence<Component>, ConstrainedVisual, Visual

public class Prompt
extends Sheet

Class representing a "prompt", a sheet commonly used to facilitate simple user interaction.


Nested Class Summary
 class Prompt.OptionSequence
          Option sequence implementation.
 
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.DecoratorSequence, Component.StyleDictionary, Component.UserDataDictionary
 
Nested classes/interfaces inherited from interface org.apache.pivot.collections.Sequence
Sequence.Tree<T>
 
Constructor Summary
Prompt()
           
Prompt(MessageType type, String message, Sequence<?> options)
           
Prompt(MessageType type, String message, Sequence<?> options, Component body)
           
 
Method Summary
 Component getBody()
           
 String getMessage()
           
 MessageType getMessageType()
           
 Prompt.OptionSequence getOptions()
           
 ListenerList<PromptListener> getPromptListeners()
           
 int getSelectedOption()
           
static void prompt(MessageType messageType, String message, Component body, Window owner)
           
static void prompt(MessageType messageType, String message, Component body, Window owner, SheetCloseListener sheetCloseListener)
           
static void prompt(MessageType messageType, String message, Window owner)
           
static void prompt(MessageType messageType, String message, Window owner, SheetCloseListener sheetCloseListener)
           
static void prompt(String message, Window owner)
           
 void setBody(Component body)
           
 void setMessage(String message)
           
 void setMessageType(MessageType messageType)
           
 void setOptions(String options)
           
 void setSelectedOption(int selectedOption)
           
 
Methods inherited from class org.apache.pivot.wtk.Sheet
close, close, getResult, getSheetCloseListener, getSheetStateListeners, isClosing, open, open, open
 
Methods inherited from class org.apache.pivot.wtk.Window
align, align, clearActive, clearFocusDescendant, descendantGainedFocus, descendantRemoved, getActionMappings, getActiveWindow, getClientArea, getContent, getFocusDescendant, getIcon, getOwnedWindow, getOwnedWindowCount, getOwner, getRootOwner, getTitle, getWindowActionMappingListeners, getWindowClassListeners, getWindowListeners, getWindowStateListeners, isActive, isClosed, isMaximized, isOpen, isOpening, isOwner, keyReleased, moveToBack, moveToFront, open, open, remove, requestActive, setActive, setContent, setEnabled, setIcon, setIcon, setIcon, setMaximized, setParent, setTitle, setVisible
 
Methods inherited from class org.apache.pivot.wtk.Container
add, clear, containsFocus, descendantAdded, descendantLostFocus, get, getComponentAt, getContainerListeners, getContainerMouseListeners, getDescendantAt, getFocusTraversalPolicy, getLength, indexOf, insert, isAncestor, iterator, layout, load, mouseClick, mouseDown, mouseMove, mouseOut, mouseUp, mouseWheel, move, paint, remove, removeAll, requestFocus, setFocusTraversalPolicy, store, transferFocus, update
 
Methods inherited from class org.apache.pivot.wtk.Component
clearFocus, getAncestor, getAttribute, getAutomationID, getBaseline, getBaseline, getBounds, getComponentClassListeners, getComponentDataListeners, getComponentDecoratorListeners, getComponentKeyListeners, getComponentListeners, getComponentMouseButtonListeners, getComponentMouseListeners, getComponentMouseWheelListeners, getComponentStateListeners, getCursor, getDecoratedBounds, getDecorators, getDisplay, getDragSource, getDropTarget, getFocusedComponent, getGraphics, 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, installThemeSkin, invalidate, isBlocked, isEnabled, isFocusable, isFocused, isMouseOver, isOpaque, isPreferredHeightSet, isPreferredSizeSet, isPreferredWidthSet, isShowing, isValid, isVisible, keyPressed, keyTyped, mapPointFromAncestor, mapPointFromAncestor, mapPointToAncestor, mapPointToAncestor, mouseOver, reenterMouse, repaint, repaint, repaint, repaint, repaint, repaint, scrollAreaToVisible, scrollAreaToVisible, setAttribute, setAutomationID, 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, toString, transferFocus, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Prompt

public Prompt()

Prompt

public Prompt(MessageType type,
              String message,
              Sequence<?> options)

Prompt

public Prompt(MessageType type,
              String message,
              Sequence<?> options,
              Component body)
Method Detail

getMessageType

public MessageType getMessageType()

setMessageType

public void setMessageType(MessageType messageType)

getMessage

public String getMessage()

setMessage

public void setMessage(String message)

getBody

public Component getBody()

setBody

public void setBody(Component body)

getOptions

public Prompt.OptionSequence getOptions()

setOptions

public void setOptions(String options)

getSelectedOption

public int getSelectedOption()

setSelectedOption

public void setSelectedOption(int selectedOption)

getPromptListeners

public ListenerList<PromptListener> getPromptListeners()

prompt

public static void prompt(String message,
                          Window owner)

prompt

public static void prompt(MessageType messageType,
                          String message,
                          Window owner)

prompt

public static void prompt(MessageType messageType,
                          String message,
                          Window owner,
                          SheetCloseListener sheetCloseListener)

prompt

public static void prompt(MessageType messageType,
                          String message,
                          Component body,
                          Window owner)

prompt

public static void prompt(MessageType messageType,
                          String message,
                          Component body,
                          Window owner,
                          SheetCloseListener sheetCloseListener)