com.jidesoft.swing
Class SidePane

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.jidesoft.swing.SidePane

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants

Direct Known Subclasses:

AutoHideContainer

public class SidePane
extends JPanel
implements SwingConstants, Accessible

SidePane is a component that can display several buttons horzontally or vertically. It usually attaches to side of a JFrame.

Buttons in SidePane can be grouped. Each group is called SidePaneGroup. Each button in the group is called SidePaneItem.

See Also:

Serialized Form

Nested Class Summary

protected class

SidePane.AccessibleSidePane This class implements accessibility support for the SidePane class.

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

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 javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

SidePane(int attachedSide)
Constructor thats takes the side which this component is attached to.

Method Summary

void	addGroup(SidePaneGroup group) Adds a SidePaneGroup to this component.
AccessibleContext	getAccessibleContext() Gets the AccessibleContext associated with this JToolBar.
int	getAttachedSide() Gets attached side.
List<SidePaneGroup>	getGroups() Gets the list of groups in this components.
String	getToolTipText(MouseEvent event)
SidePaneUI	getUI() Returns the UI object which implements the L&F for this component.
String	getUIClassID() Returns the name of the UI class that implements the L&F for this component.
boolean	isRollover() Is the side pane expand when mouse moves over?
void	removeGroup(int index) Removes a SidePaneGroup at a spefific index from this component.
void	removeGroup(SidePaneGroup group) Removes a SidePaneGroup from this component.
void	setAttachedSide(int attachedSide) Sets the attached side.
void	setRollover(boolean rollover) Set if the side pane expand when mouse moves over.
void	setUI(SidePaneUI ui) Sets the UI object which implements the L&F for this component.
void	updateUI() Resets the UI property to a value from the current look and feel.

Methods inherited from class javax.swing.JPanel

paramString, setUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, 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

Constructor Detail

SidePane

public SidePane(int attachedSide)

Constructor thats takes the side which this component is attached to.

Parameters:

attachedSide - the side which this component is attached to. Possible values are:

• SwingConstants.NORTH
• SwingConstants.SOUTH
• SwingConstants.WEST
• SwingConstants.EAST

Throws:

IllegalArgumentException - if the value is not one of NORTH, SOUTH, WEST, or EAST.

Method Detail

getUI

public SidePaneUI getUI()

Returns the UI object which implements the L&F for this component.

Overrides:

getUI in class JPanel

Returns:

a TabbedPaneUI object

See Also:

setUI(com.jidesoft.plaf.SidePaneUI)

setUI

public void setUI(SidePaneUI ui)

Sets the UI object which implements the L&F for this component.

Parameters:

ui - the new UI object

See Also:

UIDefaults.getUI(javax.swing.JComponent)

updateUI

public void updateUI()

Resets the UI property to a value from the current look and feel.

Overrides:

updateUI in class JPanel

See Also:

JComponent.updateUI()

getUIClassID

public String getUIClassID()

Returns the name of the UI class that implements the L&F for this component.

Overrides:

getUIClassID in class JPanel

Returns:

the string "TabbedPaneUI"

See Also:

JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

addGroup

public void addGroup(SidePaneGroup group)

Adds a SidePaneGroup to this component. Do nothing if there is nothing in the group.

Parameters:

group - the group to be added

removeGroup

public void removeGroup(SidePaneGroup group)

Removes a SidePaneGroup from this component.

Parameters:

group - the group to be removed

removeGroup

public void removeGroup(int index)

Removes a SidePaneGroup at a spefific index from this component.

Parameters:

index - position of the group to be removed

getGroups

public List<SidePaneGroup> getGroups()

Gets the list of groups in this components.

Returns:

the list of groups

getAttachedSide

public int getAttachedSide()

Gets attached side.

Returns:

the attached side

setAttachedSide

public void setAttachedSide(int attachedSide)

Sets the attached side. It will call updateUI automatically. Possible values are:

• SwingConstants.NORTH
• SwingConstants.SOUTH
• SwingConstants.WEST
• SwingConstants.EAST

Note: Please call this method before this component is rendered on screen.

Parameters:

attachedSide - the attached side

Throws:

IllegalArgumentException - if the value is not one of valid values

isRollover

public boolean isRollover()

Is the side pane expand when mouse moves over?

Returns:

if true, side pane will expand when mouse moves over.

setRollover

public void setRollover(boolean rollover)

Set if the side pane expand when mouse moves over.

Parameters:

rollover - the flag

getToolTipText

public String getToolTipText(MouseEvent event)

Overrides:

getToolTipText in class JComponent

getAccessibleContext

public AccessibleContext getAccessibleContext()

Gets the AccessibleContext associated with this JToolBar. For tool bars, the AccessibleContext takes the form of an AccessibleJToolBar. A new AccessibleJToolBar instance is created if necessary.

Specified by:

getAccessibleContext in interface Accessible

Overrides:

getAccessibleContext in class JPanel

Returns:

an AccessibleJToolBar that serves as the AccessibleContext of this JToolBar