org.apache.pivot.wtk
Class Sheet

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
All Implemented Interfaces:
Iterable<Component>, Sequence<Component>, ConstrainedVisual, Visual
Direct Known Subclasses:
FileBrowserSheet, Prompt

public class Sheet
extends Window

Window class representing a "sheet". A sheet behaves like a dialog that is modal only over a window's content component.


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
Sheet()
          Creates a new sheet.
Sheet(Component content)
          Creates a new sheet with an initial content component.
 
Method Summary
 void close()
          Closes the window and all of its owned windows.
 void close(boolean resultArgument)
           
 boolean getResult()
           
 SheetCloseListener getSheetCloseListener()
           
 ListenerList<SheetStateListener> getSheetStateListeners()
           
 boolean isClosing()
          Returns this window's closing state.
 void open(Display display, Window owner)
          Opens the window.
 void open(Display display, Window owner, SheetCloseListener sheetCloseListenerArgument)
           
 void open(Window owner, SheetCloseListener sheetCloseListenerArgument)
           
 
Methods inherited from class org.apache.pivot.wtk.Window
align, align, clearActive, clearFocusDescendant, descendantGainedFocus, 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, moveToFront, open, open, remove, 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, descendantLostFocus, 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

Sheet

public Sheet()
Creates a new sheet.


Sheet

public Sheet(Component content)
Creates a new sheet with an initial content component.

Parameters:
content - The sheet's content component.
Method Detail

open

public final void open(Window owner,
                       SheetCloseListener sheetCloseListenerArgument)

open

public final void open(Display display,
                       Window owner)
Description copied from class: Window
Opens the window.

Note that this method is not a synchronous call, it schedules an event to open the window.

Overrides:
open in class Window
Parameters:
display - The display on which the window will be opened.
owner - The window's owner, or null if the window has no owner.

open

public void open(Display display,
                 Window owner,
                 SheetCloseListener sheetCloseListenerArgument)

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)

getSheetCloseListener

public SheetCloseListener getSheetCloseListener()

getResult

public boolean getResult()

getSheetStateListeners

public ListenerList<SheetStateListener> getSheetStateListeners()