HOME

com.ultraswing
Class AutoHideDockablePanel

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--com.ultraswing.DockablePanel
                                |
                                +--com.ultraswing.AutoHideDockablePanel
All Implemented Interfaces:
Accessible, EventListener, ImageObserver, MenuContainer, PropertyChangeListener, Serializable

public class AutoHideDockablePanel
extends DockablePanel

A component similar to components in Visual Studio.Net and IDEA. An AutoHideDockablePanel will become invisible if it's in AutoHide state and without focus. It's a kind of DockablePanel, so it's floatable and dockable. An AutoHideDockablePanel only can dock on a CSplitPane container.

Usage example:

 CSplitPane split = new CSplitPane();
 AutoHideDockablePanel dock = new AutoHideDockablePanel(_frame, edit, 
      title, _splitPane1, 1, isFirst);
 //add dock to a CSplitPane container
 split.addPane(dock);
 

See Also:
Serialized Form

Field Summary
static int AUTO_HIDE_BUTTON
          Index for "AutoHide" button on the title bar
static int DOCK_BUTTON
          Index of "Dock" button on the title bar
 
Fields inherited from class com.ultraswing.DockablePanel
CLOSE_BUTTON, DOCK_ANYWHERE, DOCK_FIRST, DOCK_LAST
 
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
AutoHideDockablePanel(Component comp, String title, CSplitPane container, float weight, boolean isFirst)
          Constructor.
AutoHideDockablePanel(Component comp, String title, CSplitPane container, float weight, boolean isFirst, boolean isVertical)
          Constructor
 
Method Summary
 void doFloat(Point location, Dimension size)
          Floats this panel
 void setToolTipText(int index, String tooltip)
          Sets tooltip text for buttons
 
Methods inherited from class com.ultraswing.DockablePanel
addDockingListener, addFocusListener, close, getComponent, getDockPreference, getFloatingFrameSize, getTitleBar, isDockable, isFloating, processEvent, propertyChange, removeDockingListener, removeFocusListener, restore, restore, setDockable, setDockPreference, setFloatingFrameSize, setFrame, setTitleBarColors, setVisible
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
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, 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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, 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, unregisterKeyboardAction, update
 
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, 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, isVisible, 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, 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

AUTO_HIDE_BUTTON

public static final int AUTO_HIDE_BUTTON
Index for "AutoHide" button on the title bar

See Also:
setToolTipText(int, java.lang.String), Constant Field Values

DOCK_BUTTON

public static final int DOCK_BUTTON
Index of "Dock" button on the title bar

See Also:
setToolTipText(int, java.lang.String), Constant Field Values
Constructor Detail

AutoHideDockablePanel

public AutoHideDockablePanel(Component comp,
                             String title,
                             CSplitPane container,
                             float weight,
                             boolean isFirst)
Constructor. Creates an AutoHideDockablePanel with horizontal title

Parameters:
comp - the component which will be displayed at the center of this panel
title - title string of title bar
container - the containing splitpane when this panel is in docking state. This splitpane must be already added to its own parent container.
weight - The weight of this panel when it's in docking state
isFirst - it determines which pane to dock when it changes from floating to docking state. If true, this panel will take the first pane of split pane. If false, it will take the last pane.

AutoHideDockablePanel

public AutoHideDockablePanel(Component comp,
                             String title,
                             CSplitPane container,
                             float weight,
                             boolean isFirst,
                             boolean isVertical)
Constructor

Parameters:
comp - the component which will be displayed at the center of this panel
title - title string of title bar
container - the containing splitpane when this panel is in docking state This splitpane must be already added to its own parent container.
weight - The weight of this panel when it's in docking state
isFirst - it determine which pane to dock when it changes from floating to docking state. If true, this panel will take the first pane of split pane. If false, it will take the last pane.
isVertical - if true, title bar will be vertical
Method Detail

setToolTipText

public void setToolTipText(int index,
                           String tooltip)
Sets tooltip text for buttons

Overrides:
setToolTipText in class DockablePanel
Parameters:
index - CLOSE_BUTTON : close button; AUTO_HIDE_BUTTON : auto hide button; DOCK_BUTTON : dock button
tooltip - tooltip text

doFloat

public void doFloat(Point location,
                    Dimension size)
Floats this panel

Overrides:
doFloat in class DockablePanel
Parameters:
location - the location of this panel when it's in floating state
size - the size of this panel when it's in floating state

HOME

Copyright © 2002 iReasoning Networks. All Rights Reserved.