Package com.jidesoft.swing

Class SidePane

  • All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.SwingConstants
    public class SidePane
extends javax.swing.JPanel
implements javax.swing.SwingConstants, javax.accessibility.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

      Nested Classes 
      Modifier and Type Class Description
      protected class  SidePane.AccessibleSidePane
      This class implements accessibility support for the SidePane class.

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

        javax.swing.JPanel.AccessibleJPanel

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

        javax.swing.JComponent.AccessibleJComponent

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

        java.awt.Container.AccessibleAWTContainer

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

        java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

    • Field Summary

      • Fields inherited from class javax.swing.JComponent

        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

        accessibleContext, 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

      • 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

    • Constructor Summary

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addGroup​(SidePaneGroup group)
      Adds a SidePaneGroup to this component.
      javax.accessibility.AccessibleContext getAccessibleContext()
      Gets the AccessibleContext associated with this JToolBar.
      int getAttachedSide()
      Gets attached side.
      java.util.List<SidePaneGroup> getGroups()
      Gets the list of groups in this components.
      java.lang.String getToolTipText​(java.awt.event.MouseEvent event)  
      SidePaneUI getUI()
      Returns the UI object which implements the L&F for this component.
      java.lang.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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, 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:
        java.lang.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 javax.swing.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 javax.swing.JPanel
        See Also:
        JComponent.updateUI()

      • getUIClassID

        public java.lang.String getUIClassID()
        Returns the name of the UI class that implements the L&F for this component.
        Overrides:
        getUIClassID in class javax.swing.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 java.util.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:
        java.lang.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 java.lang.String getToolTipText​(java.awt.event.MouseEvent event)
        Overrides:
        getToolTipText in class javax.swing.JComponent

      • getAccessibleContext

        public javax.accessibility.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 javax.accessibility.Accessible
        Overrides:
        getAccessibleContext in class javax.swing.JPanel
        Returns:
        an AccessibleJToolBar that serves as the AccessibleContext of this JToolBar