Diamond Control Suite 3.0

diamondedge.swing
Class DsSlidingTabBar

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by diamondedge.swing.DsSlidingTabBar
All Implemented Interfaces:
ActionListener, ImageObserver, MenuContainer, Serializable, EventListener

public class DsSlidingTabBar
extends JComponent
implements ActionListener

See Also:
Serialized Form

Nested Class Summary
static class DsSlidingTabBar.ButtonGroup
           
 
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 java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
DsSlidingTabBar()
           
 
Method Summary
 void actionPerformed(ActionEvent e)
           
 void addActionGroupChangeListener(ActionGroupChangeListener l)
          Adds an ActionGroupChangeListener that will be triggered whenever the current group (tab) is changed to a new group.
 DsActionGroup addGroup(int index, String key, String title)
           
 DsActionGroup addGroup(String title, Icon icon, String tooltip)
           
 void clear()
          Removes all groups from the component.
protected  DsActionGroup createGroup(String title, Icon icon, String tooltip, int alignmentHor, ActionListener l)
          Create a new group.
 DsActionGroup getCurrentGroup()
          Returns the current selected action group.
 DsActionGroup getGroup(int index)
           
 DsActionGroup getGroup(String key)
           
 int getGroupCount()
          Returns the number of groups in the collection.
 int getHorizontalAlignment()
          Returns the horizontal alignment of the contents (text and icon) of each tab.
 void removeActionGroupChangeListener(ActionGroupChangeListener l)
          Removes an ChangeListener from this component.
 DsActionGroup removeGroup(int index)
           
 DsActionGroup removeGroup(String key)
           
 void setGroupCount(int val)
          Sets the number of groups in the collection.
 void setHorizontalAlignment(int align)
          Sets the horizontal alignment of the contents (text and icon) of each tab (NavigationComponent).
 void setIconAt(int index, Icon icon)
           
 void setToolTipTextAt(int index, String tooltip)
           
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, 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, updateUI
 
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

DsSlidingTabBar

public DsSlidingTabBar()
Method Detail

getGroupCount

public int getGroupCount()
Returns the number of groups in the collection.


setGroupCount

public void setGroupCount(int val)
Sets the number of groups in the collection.


getCurrentGroup

public DsActionGroup getCurrentGroup()
Returns the current selected action group.


getGroup

public DsActionGroup getGroup(int index)

getGroup

public DsActionGroup getGroup(String key)

removeGroup

public DsActionGroup removeGroup(int index)

removeGroup

public DsActionGroup removeGroup(String key)

clear

public void clear()
Removes all groups from the component.


addGroup

public DsActionGroup addGroup(int index,
                              String key,
                              String title)

addGroup

public DsActionGroup addGroup(String title,
                              Icon icon,
                              String tooltip)

setIconAt

public void setIconAt(int index,
                      Icon icon)

setToolTipTextAt

public void setToolTipTextAt(int index,
                             String tooltip)

getHorizontalAlignment

public int getHorizontalAlignment()
Returns the horizontal alignment of the contents (text and icon) of each tab.


setHorizontalAlignment

public void setHorizontalAlignment(int align)
Sets the horizontal alignment of the contents (text and icon) of each tab (NavigationComponent).
 LEFT    - contents are left-aligned.
 CENTER  - contents are centered. (Default)
 RIGHT   - contents are right-aligned.
 LEADING - contents are aligned to the leading edge (at the beginning). (Default)
 TRAILING- contents are aligned to the trailing edge (at the end).

Note: This is only used during the creation of the groups, so it must be set before any groups are created.


createGroup

protected DsActionGroup createGroup(String title,
                                    Icon icon,
                                    String tooltip,
                                    int alignmentHor,
                                    ActionListener l)
Create a new group. Can be overridden to create customized groups/buttons.


addActionGroupChangeListener

public void addActionGroupChangeListener(ActionGroupChangeListener l)
Adds an ActionGroupChangeListener that will be triggered whenever the current group (tab) is changed to a new group.

Parameters:
l - the ChangeListener to be added

removeActionGroupChangeListener

public void removeActionGroupChangeListener(ActionGroupChangeListener l)
Removes an ChangeListener from this component.

Parameters:
l - the listener to be removed

actionPerformed

public void actionPerformed(ActionEvent e)
Specified by:
actionPerformed in interface ActionListener

Diamond Control Suite 3.0

Diamond Edge and Diamond Control Suite are trademarks or registered trademarks of Diamond Edge, Inc. Copyright 1999-2005 Diamond Edge, Inc. All Rights Reserved.