com.l2fprod.common.swing
Class JOutlookBar

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JTabbedPane
                  extended bycom.l2fprod.common.swing.JOutlookBar
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.swing.SwingConstants

public class JOutlookBar
extends javax.swing.JTabbedPane

JOutlookBar brings the famous Outlook component to Swing. The component shows stacks of components where only one stack is visible at a time.
The tab orientation of the JTabbedPaneis mapped to the JOutlookBar orientation as follow:

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JTabbedPane
javax.swing.JTabbedPane.AccessibleJTabbedPane, javax.swing.JTabbedPane.ModelListener
 
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
static java.lang.String ANIMATED_CHANGED_KEY
          Used when generating PropertyChangeEvents for the "animated" property
protected  java.util.Map extendedPages
           
static java.lang.String UI_CLASS_ID
           
 
Fields inherited from class javax.swing.JTabbedPane
changeEvent, changeListener, model, SCROLL_TAB_LAYOUT, tabPlacement, WRAP_TAB_LAYOUT
 
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
JOutlookBar()
           
JOutlookBar(int tabPlacement)
           
 
Method Summary
protected  void addImpl(java.awt.Component comp, java.lang.Object constraints, int index)
           
 int getAlignmentAt(int index)
           
 java.awt.Color getBackgroundAt(int index)
           
protected  com.l2fprod.common.swing.JOutlookBar.ExtendedPage getExtendedPage(int index)
           
 java.awt.Color getForegroundAt(int index)
           
 java.lang.String getUIClassID()
          Returns the name of the L&F class that renders this component.
 boolean isAnimated()
           
 javax.swing.JScrollPane makeScrollPane(java.awt.Component component)
          Builds a JScrollPane to hold the component.
protected  void removeExtendedPage(int index)
           
 void removeTabAt(int index)
           
 void setAlignmentAt(int index, int alignment)
          Sets the title alignment of the tab at index
 void setAllTabsAlignment(int alignment)
          Sets the title alignment for all tabs
 void setAnimated(boolean animated)
          Enables or disables animation during tab transition.
 void setBackgroundAt(int index, java.awt.Color background)
          Overriden to notify the UI about the change
 void setDisabledIconAt(int index, javax.swing.Icon disabledIcon)
          Overriden to notify the UI about the change
 void setDisplayedMnemonicIndexAt(int tabIndex, int mnemonicIndex)
          Overriden to notify the UI about the change
 void setEnabledAt(int index, boolean enabled)
          Overriden to notify the UI about the change
 void setForegroundAt(int index, java.awt.Color foreground)
          Overriden to notify the UI about the change
 void setIconAt(int index, javax.swing.Icon icon)
          Overriden to notify the UI about the change
 void setMnemonicAt(int index, int mnemonic)
          Overriden to notify the UI about the change
 void setTitleAt(int index, java.lang.String title)
          Overriden to notify the UI about the change
 void setToolTipTextAt(int index, java.lang.String toolTipText)
          Overriden to notify the UI about the change
 void setUI(OutlookBarUI ui)
          Sets the L&F object that renders this component.
 void updateUI()
          Notification from the UIManager that the L&F has changed.
 
Methods inherited from class javax.swing.JTabbedPane
add, add, add, add, add, addChangeListener, addTab, addTab, addTab, createChangeListener, fireStateChanged, getAccessibleContext, getBoundsAt, getChangeListeners, getComponentAt, getDisabledIconAt, getDisplayedMnemonicIndexAt, getIconAt, getMnemonicAt, getModel, getSelectedComponent, getSelectedIndex, getTabCount, getTabLayoutPolicy, getTabPlacement, getTabRunCount, getTitleAt, getToolTipText, getToolTipTextAt, getUI, indexAtLocation, indexOfComponent, indexOfTab, indexOfTab, insertTab, isEnabledAt, paramString, remove, remove, removeAll, removeChangeListener, setComponentAt, setModel, setSelectedComponent, setSelectedIndex, setTabLayoutPolicy, setTabPlacement, setUI
 
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, 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, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
addContainerListener, 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, 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, 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, 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

UI_CLASS_ID

public static final java.lang.String UI_CLASS_ID
See Also:
Constant Field Values

ANIMATED_CHANGED_KEY

public static final java.lang.String ANIMATED_CHANGED_KEY
Used when generating PropertyChangeEvents for the "animated" property

See Also:
Constant Field Values

extendedPages

protected java.util.Map extendedPages
Constructor Detail

JOutlookBar

public JOutlookBar()

JOutlookBar

public JOutlookBar(int tabPlacement)
Parameters:
tabPlacement -
Method Detail

updateUI

public void updateUI()
Notification from the UIManager that the L&F has changed. Replaces the current UI object with the latest version from the UIManager.

See Also:
JComponent.updateUI()

setUI

public void setUI(OutlookBarUI ui)
Sets the L&F object that renders this component.

Parameters:
ui - the OutlookBarUI L&F object
See Also:
UIDefaults.getUI(javax.swing.JComponent)

getUIClassID

public java.lang.String getUIClassID()
Returns the name of the L&F class that renders this component.

Returns:
the string UI_CLASS_ID
See Also:
JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

setAnimated

public void setAnimated(boolean animated)
Enables or disables animation during tab transition.

Parameters:
animated -

isAnimated

public boolean isAnimated()
Returns:
true if this taskpane is animated during expand/collapse transition.

makeScrollPane

public javax.swing.JScrollPane makeScrollPane(java.awt.Component component)
Builds a JScrollPane to hold the component. By default tabs are not scrollable. They can be made scrollable by putting them in a JScrollPane and adding the JScrollPane instead of the tab to the JOutlookBar. It is recommended to use this method to create the scrollbar as the UI may choose to return a JScrollPane specially configured for the JOutlookBar component (ex. with different scrollbars)

Parameters:
component -
Returns:
a JScrollPane with component as view

removeTabAt

public void removeTabAt(int index)

setAllTabsAlignment

public void setAllTabsAlignment(int alignment)
Sets the title alignment for all tabs

Parameters:
alignment - one of SwingConstants.LEFT, SwingConstants.CENTER, SwingConstants.RIGHT.

setAlignmentAt

public void setAlignmentAt(int index,
                           int alignment)
Sets the title alignment of the tab at index

Parameters:
index -
alignment - one of SwingConstants.LEFT, SwingConstants.CENTER, SwingConstants.RIGHT.

getAlignmentAt

public int getAlignmentAt(int index)
Parameters:
index -
Returns:
the title alignment of the tab at index

setTitleAt

public void setTitleAt(int index,
                       java.lang.String title)
Overriden to notify the UI about the change


setIconAt

public void setIconAt(int index,
                      javax.swing.Icon icon)
Overriden to notify the UI about the change


getBackgroundAt

public java.awt.Color getBackgroundAt(int index)

setBackgroundAt

public void setBackgroundAt(int index,
                            java.awt.Color background)
Overriden to notify the UI about the change


getForegroundAt

public java.awt.Color getForegroundAt(int index)

setForegroundAt

public void setForegroundAt(int index,
                            java.awt.Color foreground)
Overriden to notify the UI about the change


setToolTipTextAt

public void setToolTipTextAt(int index,
                             java.lang.String toolTipText)
Overriden to notify the UI about the change


setDisplayedMnemonicIndexAt

public void setDisplayedMnemonicIndexAt(int tabIndex,
                                        int mnemonicIndex)
Overriden to notify the UI about the change


setMnemonicAt

public void setMnemonicAt(int index,
                          int mnemonic)
Overriden to notify the UI about the change


setDisabledIconAt

public void setDisabledIconAt(int index,
                              javax.swing.Icon disabledIcon)
Overriden to notify the UI about the change


setEnabledAt

public void setEnabledAt(int index,
                         boolean enabled)
Overriden to notify the UI about the change


addImpl

protected void addImpl(java.awt.Component comp,
                       java.lang.Object constraints,
                       int index)

removeExtendedPage

protected void removeExtendedPage(int index)

getExtendedPage

protected com.l2fprod.common.swing.JOutlookBar.ExtendedPage getExtendedPage(int index)


Copyright (c) 2005-2006 L2FProd.com. All Rights Reserved.