com.sygem.swing.joutlooknavbar
Class JOutlookNavBar

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended bycom.sygem.swing.joutlooknavbar.JOutlookNavBar
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class JOutlookNavBar
extends javax.swing.JComponent
implements java.io.Serializable

The main class of the JOutlookNavBar component, simulating Outlook's Navigation Bar.

The interface consists of a series of Categories - each of which has a header and a number of items. Clicking on a closed category's header will open up that category.

Uses a data model to store the categories, registering an event listener to listen for changes to the model and react accordingly.

Title: JOutlookNavBar
Description: A Swing component simulating Outlook's Nav Bar
Copyright: Copyright (c) 2004
Company: SyGem Software

Version:
1.2d
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Field Summary
 
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, 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
JOutlookNavBar()
          Simple constructor, creates an empty CategoryModel to store categories in.
JOutlookNavBar(CategoryModel model)
          Constructs a JOutlookNavBar with the specified model.
 
Method Summary
 int getAnimationDelay()
          Gets the current value of the delay between animation frames (in milliseconds)
 int getAnimationFrames()
          Gets the number of frames in the animation of the categories.
 CategoryModel getModel()
          Returns the model currently being used to store categories.
 NavBarCategory getOpenCategory()
          Returns the currently opened NavBarCategory
 boolean isAntiAliased()
          Returns whether or not anti-aliasing is used in the rendering of this JOutlookNavBar.
 void openCategory(NavBarCategory cat, boolean generateEvent)
          Allows you to programmatically open a NavBarCategory.
 void reshape(int x, int y, int w, int h)
          Overridden to ensure that changes in the size of the JOutlookNavBar are handled correctly.
 void setAnimationDelay(int animationDelay)
          Sets the time between frames of the category animation (in milliseconds).
 void setAnimationFrames(int animationFrames)
          Sets the number of frames in the category animation.
 void setAntiAliased(boolean antiAliased)
          If set to true, JOutlookNavBar will render all its components with smooth (anti-aliased) edges.
 void setModel(CategoryModel newCategoryModel)
          Sets the model of this JOutlookNavBar.
 
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, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI
 
Methods inherited from class java.awt.Container
add, add, add, add, add, 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, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, 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, 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
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JOutlookNavBar

public JOutlookNavBar()
Simple constructor, creates an empty CategoryModel to store categories in.


JOutlookNavBar

public JOutlookNavBar(CategoryModel model)
Constructs a JOutlookNavBar with the specified model.

Parameters:
model - A CategoryModel
Method Detail

getAnimationDelay

public int getAnimationDelay()
Gets the current value of the delay between animation frames (in milliseconds)

Returns:
The animation delay

getAnimationFrames

public int getAnimationFrames()
Gets the number of frames in the animation of the categories.

Returns:
The number of frames

getModel

public CategoryModel getModel()
Returns the model currently being used to store categories.

Returns:
The current CategoryModel

getOpenCategory

public NavBarCategory getOpenCategory()
Returns the currently opened NavBarCategory

Returns:
an open NavBarCategory

isAntiAliased

public boolean isAntiAliased()
Returns whether or not anti-aliasing is used in the rendering of this JOutlookNavBar. The default value is false.

Returns:
True is this JOutlookNavBar is being rendered using AntiAliasing

openCategory

public void openCategory(NavBarCategory cat,
                         boolean generateEvent)
Allows you to programmatically open a NavBarCategory. If the category is already open, no action is performed. You may also specify whether or not any ActionListeners associated with the NavBarCategory receive events when the category is opened.

Parameters:
cat - The NavBarCategory to open
generateEvent - A value of TRUE will cause events to be generated

reshape

public void reshape(int x,
                    int y,
                    int w,
                    int h)
Overridden to ensure that changes in the size of the JOutlookNavBar are handled correctly.

Parameters:
x - X position
y - Y Position
w - Width
h - Height

setAnimationDelay

public void setAnimationDelay(int animationDelay)
Sets the time between frames of the category animation (in milliseconds). The default value is 50.

Parameters:
animationDelay - The animation delay

setAnimationFrames

public void setAnimationFrames(int animationFrames)
Sets the number of frames in the category animation.

Parameters:
animationFrames - The number of animation frames

setAntiAliased

public void setAntiAliased(boolean antiAliased)
If set to true, JOutlookNavBar will render all its components with smooth (anti-aliased) edges. This really improves the look of your interfaces.

Parameters:
antiAliased - boolean

setModel

public void setModel(CategoryModel newCategoryModel)
Sets the model of this JOutlookNavBar.

Parameters:
newCategoryModel - The new CategoryModel


Copyright © 2004 SyGem Software. All Rights Reserved.