pivot.wtk
Class Prompt

java.lang.Object
  extended by pivot.wtk.Component
      extended by pivot.wtk.Container
          extended by pivot.wtk.Window
              extended by pivot.wtk.Sheet
                  extended by pivot.wtk.Prompt
All Implemented Interfaces:
java.lang.Iterable<Component>, Sequence<Component>, ConstrainedVisual, Visual

public class Prompt
extends Sheet

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

Prompt is a semantic sibling of Alert, but whereas alerts are dialogs, prompts are sheets, meaning that an alert will be modal over its entire owner hierarchy (its entire "application", in common usage) but a prompt will be modal only over its owner's content.

Author:
tvolkert

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
Prompt(MessageType type, java.lang.String message, Sequence<?> options)
           
Prompt(MessageType type, java.lang.String message, Sequence<?> options, Component body)
           
 
Method Summary
 Component getBody()
           
 java.lang.String getMessage()
           
 MessageType getMessageType()
           
 java.lang.Object getOption(int index)
           
 int getOptionCount()
           
 ListenerList<PromptListener> getPromptListeners()
           
 int getSelectedOption()
           
static void prompt(MessageType type, java.lang.String message, Window owner)
           
static void prompt(MessageType type, java.lang.String message, Window owner, SheetStateListener sheetStateListener)
           
static void prompt(java.lang.String message, Window owner)
           
static void prompt(java.lang.String message, Window owner, SheetStateListener sheetStateListener)
           
 void setSelectedOption(int selectedOption)
           
 
Methods inherited from class pivot.wtk.Sheet
close, close, getResult, getSheetCloseListener, getSheetStateListeners, open, open, open, setOwner, setSize
 
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, 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, 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

Prompt

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

Prompt

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

getMessageType

public MessageType getMessageType()

getMessage

public java.lang.String getMessage()

getOption

public java.lang.Object getOption(int index)

getOptionCount

public int getOptionCount()

getBody

public Component getBody()

getSelectedOption

public int getSelectedOption()

setSelectedOption

public void setSelectedOption(int selectedOption)

getPromptListeners

public ListenerList<PromptListener> getPromptListeners()

prompt

public static void prompt(java.lang.String message,
                          Window owner)

prompt

public static void prompt(java.lang.String message,
                          Window owner,
                          SheetStateListener sheetStateListener)

prompt

public static void prompt(MessageType type,
                          java.lang.String message,
                          Window owner)

prompt

public static void prompt(MessageType type,
                          java.lang.String message,
                          Window owner,
                          SheetStateListener sheetStateListener)