edu.ou.kmi.buddyspace.utils
Class DockableWindow

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--edu.ou.kmi.buddyspace.utils.DockableWindow
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable
Direct Known Subclasses:
AlertsDockableWindow, BSBrowseWindow, BSComposeMsgWin, BSDebugWin, BSDiscoWindow, BSMapEditWindow, BSMapWindow, BSMessagesWindow, BSPubsubWindow, BSStatusWin

public abstract class DockableWindow
extends javax.swing.JComponent

DockableWindow is window which can be docked or stand-alone.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
protected  java.awt.Container contentPane
           
protected static java.awt.Dimension DEFAULT_SIZE
           
protected  boolean docked
           
protected  javax.swing.JFrame frame
           
protected  java.awt.Image icon
           
protected  java.lang.String ID
           
protected  boolean moveToBack
           
protected  boolean select
           
protected  java.lang.String title
           
protected  java.awt.Dimension viewSize
           
protected  WinManager winMan
           
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
DockableWindow(java.lang.String ID, java.lang.String title, boolean docked, WinManager winMan)
           
DockableWindow(java.lang.String ID, java.lang.String title, java.awt.Image icon, boolean docked, WinManager winMan)
           
DockableWindow(java.lang.String ID, java.lang.String title, java.awt.Image icon, java.awt.Dimension viewSize, boolean docked, WinManager winMan)
          Main constructor...
 
Method Summary
abstract  void cancelListening()
          Removes itself from listening
 void close()
           
 void dockAsTab(javax.swing.JTabbedPane tabbedPane)
           
 javax.swing.JFrame getFrame()
           
 int getFrameHeight()
           
 int getFrameWidth()
           
 int getFrameX()
           
 int getFrameY()
           
 java.lang.String getID()
           
 java.lang.String getTitle()
           
 boolean isDocked()
           
 boolean isVisible()
           
 void prepareOnClose()
           
 void setAutoSelect(boolean select)
          Sets if the window will automatically popup
 void setDocked(boolean docked)
           
 void setDocked(boolean docked, boolean select)
           
 void setFrameLocation(int x, int y)
           
 void setFrameSize(int width, int height)
           
 void setIcon(java.awt.Image icon)
           
 void setTitle(java.lang.String title)
           
 void showWindow(boolean show)
           
 void showWindow(boolean show, boolean select)
           
 void toFront()
           
 void updateLAF()
          Updates LookAndFeel
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

frame

protected javax.swing.JFrame frame

contentPane

protected java.awt.Container contentPane

docked

protected boolean docked

icon

protected java.awt.Image icon

title

protected java.lang.String title

ID

protected java.lang.String ID

DEFAULT_SIZE

protected static java.awt.Dimension DEFAULT_SIZE

viewSize

protected java.awt.Dimension viewSize

winMan

protected WinManager winMan

select

protected boolean select

moveToBack

protected boolean moveToBack
Constructor Detail

DockableWindow

public DockableWindow(java.lang.String ID,
                      java.lang.String title,
                      boolean docked,
                      WinManager winMan)

DockableWindow

public DockableWindow(java.lang.String ID,
                      java.lang.String title,
                      java.awt.Image icon,
                      boolean docked,
                      WinManager winMan)

DockableWindow

public DockableWindow(java.lang.String ID,
                      java.lang.String title,
                      java.awt.Image icon,
                      java.awt.Dimension viewSize,
                      boolean docked,
                      WinManager winMan)
Main constructor...

Method Detail

setIcon

public void setIcon(java.awt.Image icon)

setTitle

public void setTitle(java.lang.String title)

getTitle

public java.lang.String getTitle()

getFrame

public javax.swing.JFrame getFrame()

getID

public java.lang.String getID()

setAutoSelect

public void setAutoSelect(boolean select)
Sets if the window will automatically popup


isVisible

public boolean isVisible()
Overrides:
isVisible in class java.awt.Component

isDocked

public boolean isDocked()

setDocked

public void setDocked(boolean docked)

setDocked

public void setDocked(boolean docked,
                      boolean select)

dockAsTab

public void dockAsTab(javax.swing.JTabbedPane tabbedPane)

showWindow

public void showWindow(boolean show)

showWindow

public void showWindow(boolean show,
                       boolean select)

toFront

public void toFront()

close

public void close()

prepareOnClose

public void prepareOnClose()

cancelListening

public abstract void cancelListening()
Removes itself from listening


updateLAF

public void updateLAF()
Updates LookAndFeel


getFrameX

public int getFrameX()

getFrameY

public int getFrameY()

getFrameWidth

public int getFrameWidth()

getFrameHeight

public int getFrameHeight()

setFrameSize

public void setFrameSize(int width,
                         int height)

setFrameLocation

public void setFrameLocation(int x,
                             int y)