pivot.wtk
Class Sheet

java.lang.Object
  extended by pivot.wtk.Component
      extended by pivot.wtk.Container
          extended by pivot.wtk.Window
              extended by pivot.wtk.Sheet
All Implemented Interfaces:
Iterable<Component>, Sequence<Component>, ConstrainedVisual, Visual
Direct Known Subclasses:
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.

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, Component.UserDataDictionary
 
Nested classes/interfaces inherited from interface pivot.collections.Sequence
Sequence.Search, Sequence.Sort, Sequence.Tree
 
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.
 void close(boolean result)
           
 boolean getResult()
           
 SheetCloseListener getSheetCloseListener()
           
 ListenerList<SheetStateListener> getSheetStateListeners()
           
 void open(Display display)
          Opens the window.
 void open(Window owner)
          Opens the window.
 void open(Window owner, SheetCloseListener sheetCloseListener)
           
 void setOwner(Window owner)
           
 void setSize(int width, int height)
          NOTE This method should only be called during layout.
 
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, isAncestor, isFocusable, iterator, load, mouseClick, mouseMove, mouseOut, mouseUp, mouseWheel, move, paint, remove, removeAll, requestFocus, setContextKey, setFocusTraversalPolicy, setTooltip, setVisible, 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, getGraphics, getHandle, getHeight, getLocation, getParent, getPreferredHeight, getPreferredHeight, getPreferredSize, getPreferredWidth, getPreferredWidth, getSize, getSkin, getStyles, getTooltipText, getUserData, getVisibleArea, getVisibleArea, getVisibleArea, getWidth, getWindow, getX, getY, installSkin, invalidate, isBlocked, isDisplayable, isEnabled, isFocused, isMouseOver, isOpaque, isPreferredHeightSet, isPreferredSizeSet, isPreferredWidthSet, isShowing, isValid, isVisible, keyPressed, keyReleased, keyTyped, load, mapPointFromAncestor, mapPointToAncestor, mouseOver, repaint, repaint, repaint, repaint, repaint, repaint, requestFocus, scrollAreaToVisible, scrollAreaToVisible, setAttributes, setCursor, setCursor, setDragSource, setDropTarget, setFocused, setHeight, setLocation, setLocation, setPreferredHeight, setPreferredSize, setPreferredSize, setPreferredWidth, setSize, setSkin, setStyles, setStyles, setStyles, setTooltipText, setWidth, setX, setY, store, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, 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

setSize

public void setSize(int width,
                    int height)
Description copied from class: Component
NOTE This method should only be called during layout. Callers should use Component.setPreferredSize(int, int).

Specified by:
setSize in interface ConstrainedVisual
Overrides:
setSize in class Component

setOwner

public final void setOwner(Window owner)
Overrides:
setOwner in class Window

open

public void open(Display display)
Description copied from class: Window
Opens the window. Opening a window adds it to the display's component sequence. If the window is activatable, it will become the active window.

Overrides:
open in class Window
Parameters:
display - The display on which the window will be opened.

open

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

Overrides:
open in class Window
Parameters:
owner - The window's owner.

open

public void open(Window owner,
                 SheetCloseListener sheetCloseListener)

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)

getSheetCloseListener

public SheetCloseListener getSheetCloseListener()

getResult

public boolean getResult()

getSheetStateListeners

public ListenerList<SheetStateListener> getSheetStateListeners()