com.jidesoft.dashboard
Class DashboardTabbedPane

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JTabbedPane
                  com.jidesoft.swing.JideTabbedPane
                      com.jidesoft.dashboard.DashboardTabbedPane

All Implemented Interfaces:

DashboardHolder, DashboardListener, GadgetListener, GadgetPaletteInstaller, TabEditingListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, SwingConstants

public class DashboardTabbedPane
extends JideTabbedPane
implements TabEditingListener, GadgetListener, DashboardListener, GadgetPaletteInstaller, DashboardHolder

DashboardTabbedPane contains several dashboards. Each dashboard is a tab in this tabbed pane..

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.jidesoft.swing.JideTabbedPane

JideTabbedPane.ColorProvider, JideTabbedPane.GradientColorProvider, JideTabbedPane.IgnoreableSingleSelectionModel, JideTabbedPane.NoFocusButton, JideTabbedPane.PageLastFocusTracker, JideTabbedPane.TabListCellRenderer

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

JTabbedPane.AccessibleJTabbedPane, JTabbedPane.ModelListener

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

static String	BUTTON_NAME_ADD_DASHBOARD
static String	BUTTON_NAME_SHOW_GADGET_PALETTE

Fields inherited from class com.jidesoft.swing.JideTabbedPane

_focusChangeListener, _tabEditingAllowed, _tabEditValidator, BOLDACTIVETAB_PROPERTY, BOX_STYLE_PROPERTY, BUTTON_CLOSE, BUTTON_EAST, BUTTON_LIST, BUTTON_NORTH, BUTTON_SOUTH, BUTTON_WEST, COLOR_THEME_DEFAULT, COLOR_THEME_OFFICE2003, COLOR_THEME_VSNET, COLOR_THEME_WIN2K, COLOR_THEME_WINXP, GRIPPER_PROPERTY, HIDE_IF_ONE_TAB_PROPERTY, ONENOTE_COLOR_PROVIDER, PROPERTY_COLOR_THEME, PROPERTY_CONTENT_BORDER_INSETS, PROPERTY_DRAG_OVER_DISABLED, PROPERTY_SELECTED_INDEX, PROPERTY_SHOW_CLOSE_BUTTON_ON_MOUSE_OVER, PROPERTY_TAB_AREA_INSETS, PROPERTY_TAB_COLOR_PROVIDER, PROPERTY_TAB_INSETS, PROPERTY_TAB_LEADING_COMPONENT, PROPERTY_TAB_RESIZE_MODE, PROPERTY_TAB_SHAPE, PROPERTY_TAB_TRAILING_COMPONENT, RESIZE_MODE_COMPRESSED, RESIZE_MODE_DEFAULT, RESIZE_MODE_FIT, RESIZE_MODE_FIXED, RESIZE_MODE_NONE, SCROLL_TAB_ON_WHEEL_PROPERTY, SHAPE_BOX, SHAPE_DEFAULT, SHAPE_ECLIPSE, SHAPE_ECLIPSE3X, SHAPE_EXCEL, SHAPE_FLAT, SHAPE_OFFICE2003, SHAPE_ROUNDED_FLAT, SHAPE_ROUNDED_VSNET, SHAPE_VSNET, SHAPE_WINDOWS, SHAPE_WINDOWS_SELECTED, SHOW_CLOSE_BUTTON_ON_TAB_PROPERTY, SHOW_CLOSE_BUTTON_PROPERTY, SHOW_ICONS_PROPERTY, SHOW_TAB_AREA_PROPERTY, SHOW_TAB_BUTTONS_PROPERTY, SHOW_TAB_CONTENT_PROPERTY, SHRINK_TAB_PROPERTY, TAB_CLOSABLE_PROPERTY, USE_DEFAULT_SHOW_CLOSE_BUTTON_ON_TAB_PROPERTY, USE_DEFAULT_SHOW_ICONS_PROPERTY

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

DashboardTabbedPane()

DashboardTabbedPane(GadgetManager gadgetManager)

DashboardTabbedPane(int tabPlacement)

Method Summary

Dashboard	createDashboard(String key) Creates the dashboard added by the add button.
protected GadgetPalette	createGadgetPalette()
protected Container	createToolBarComponent()
void	editingCanceled(TabEditingEvent e) This tells the listeners the tab editing is canceled
void	editingStarted(TabEditingEvent e) This tells the listeners the tab editing is started
void	editingStopped(TabEditingEvent e) This tells the listeners the tab editing is stopped
void	eventHappened(DashboardEvent e) Invoked when a Gadget event happened
void	eventHappened(GadgetEvent e) Invoked when a Gadget event happened
Dashboard	getActiveDashboard()
Dashboard	getDashboardAt(int index) Gets the dashboard at the specified index.
int	getDashboardCount() Gets the total number of dashboard.
GadgetManager	getGadgetManager() Gets the gadget manager.
protected ImageIcon	getImageIcon(String name) Gets the image icons that is used in PropertyPane.
int	getPaletteSide() Gets the palette side.
String	getResourceString(String key) Gets the localized string from resource bundle.
int	getToolBarAlignment() Gets the toolbar alignment.
Container	getToolBarComponent()
Container	getValidParent(Component c)
void	hidePalette() Hides the palette.
int	indexOfDashboard(Dashboard dashboard) Gets the index of the dashboard.
protected void	initComponents()
boolean	isPaletteVisible() Checks if the palette is visible.
boolean	isUseFloatingPalette()
void	removeTabAt(int index)
void	setPaletteSide(int paletteSide) Sets the palette side.
void	setSelectedIndex(int index)
void	setToolBar(JToolBar toolBar)
void	setToolBarAlignment(int alignment) Sets the toolbar location.
void	setUseFloatingPalette(boolean useFloatingPalette)
void	showPalette()
void	showPalette(Component invoker) Shows the palette.
void	togglePalette(Component invoker) Toggles the palette visibility.

Methods inherited from class com.jidesoft.swing.JideTabbedPane

add, addNotify, addTabEditingListener, calculateTabListPopupPosition, cancelTabEditing, clearVisComp, createFocusChangeListener, createNoFocusButton, createTabList, createTabListPopup, editTabAt, fireStateChanged, fireTabEditing, getCloseAction, getColorTheme, getContentBorderInsets, getDefaultColorTheme, getDefaultTabResizeMode, getDefaultTabStyle, getDisplayTitleAt, getEditingTabIndex, getIconForTab, getLastFocusedComponent, getPageLastFocusTrackers, getSelectedTabFont, getStringConverter, getTabAlignment, getTabAreaInsets, getTabAtLocation, getTabColorProvider, getTabEditingListeners, getTabEditingValidator, getTabHeight, getTabInsets, getTabLeadingComponent, getTabListCellRenderer, getTabResizeMode, getTabShape, getTabTrailingComponent, getUI, getUIClassID, hasFocusComponent, hideTabListPopup, insertTab, isAutoFocusOnTabHideClose, isAutoRequestFocus, isBoldActiveTab, isCloseTabOnMouseMiddleButton, isDragOverDisabled, isHideOneTab, isHideTrailingWhileNoButtons, isLayoutTrailingComponentBeforeButtons, isRightClickSelect, isScrollSelectedTabOnWheel, isShowCloseButton, isShowCloseButtonOnMouseOver, isShowCloseButtonOnSelectedTab, isShowCloseButtonOnTab, isShowGripper, isShowIconsOnTab, isShowTabArea, isShowTabButtons, isShowTabContent, isSuppressSetSelectedIndex, isSuppressStateChangedEvents, isTabClosableAt, isTabEditing, isTabEditingAllowed, isTabListPopupVisible, isTabShown, isUseDefaultShowCloseButtonOnTab, isUseDefaultShowIconsOnTab, moveSelectedTabTo, popupSelectedIndex, processMouseSelection, removeNotify, removeTabEditingListener, repaintContentBorder, repaintTabAreaAndContentBorder, requestFocusForVisibleComponent, resetDefaultCloseAction, scrollSelectedTabToVisible, setAutoFocusOnTabHideClose, setAutoRequestFocus, setBoldActiveTab, setCloseAction, setCloseTabOnMouseMiddleButton, setColorTheme, setComponentAt, setContentBorderInsets, setDragOverDisabled, setHideOneTab, setHideTrailingWhileNoButtons, setLayoutTrailingComponentBeforeButtons, setRightClickSelect, setScrollSelectedTabOnWheel, setSelectedTabFont, setShowCloseButton, setShowCloseButtonOnMouseOver, setShowCloseButtonOnSelectedTab, setShowCloseButtonOnTab, setShowGripper, setShowIconsOnTab, setShowTabArea, setShowTabButtons, setShowTabContent, setStringConverter, setSuppressSetSelectedIndex, setSuppressStateChangedEvents, setTabAlignment, setTabAreaInsets, setTabClosableAt, setTabColorProvider, setTabEditingAllowed, setTabEditingValidator, setTabInsets, setTabLeadingComponent, setTabListCellRenderer, setTabResizeMode, setTabShape, setTabTrailingComponent, setUI, setUseDefaultShowCloseButtonOnTab, setUseDefaultShowIconsOnTab, showTabListPopup, stopTabEditing, updateUI

Methods inherited from class javax.swing.JTabbedPane

add, add, add, add, addChangeListener, addTab, addTab, addTab, createChangeListener, getAccessibleContext, getBackgroundAt, getBoundsAt, getChangeListeners, getComponentAt, getDisabledIconAt, getDisplayedMnemonicIndexAt, getForegroundAt, getIconAt, getMnemonicAt, getModel, getSelectedComponent, getSelectedIndex, getTabComponentAt, getTabCount, getTabLayoutPolicy, getTabPlacement, getTabRunCount, getTitleAt, getToolTipText, getToolTipTextAt, indexAtLocation, indexOfComponent, indexOfTab, indexOfTab, indexOfTabComponent, isEnabledAt, paramString, remove, remove, removeAll, removeChangeListener, setBackgroundAt, setDisabledIconAt, setDisplayedMnemonicIndexAt, setEnabledAt, setForegroundAt, setIconAt, setMnemonicAt, setModel, setSelectedComponent, setTabComponentAt, setTabLayoutPolicy, setTabPlacement, setTitleAt, setToolTipTextAt

Methods inherited from class javax.swing.JComponent

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

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

Field Detail

BUTTON_NAME_ADD_DASHBOARD

public static final String BUTTON_NAME_ADD_DASHBOARD

See Also:

Constant Field Values

BUTTON_NAME_SHOW_GADGET_PALETTE

public static final String BUTTON_NAME_SHOW_GADGET_PALETTE

See Also:

Constant Field Values

Constructor Detail

DashboardTabbedPane

public DashboardTabbedPane()

DashboardTabbedPane

public DashboardTabbedPane(GadgetManager gadgetManager)

DashboardTabbedPane

public DashboardTabbedPane(int tabPlacement)

Method Detail

editingStarted

public void editingStarted(TabEditingEvent e)

Description copied from interface: TabEditingListener

This tells the listeners the tab editing is started

Specified by:

editingStarted in interface TabEditingListener

editingStopped

public void editingStopped(TabEditingEvent e)

Description copied from interface: TabEditingListener

This tells the listeners the tab editing is stopped

Specified by:

editingStopped in interface TabEditingListener

editingCanceled

public void editingCanceled(TabEditingEvent e)

Description copied from interface: TabEditingListener

This tells the listeners the tab editing is canceled

Specified by:

editingCanceled in interface TabEditingListener

getGadgetManager

public GadgetManager getGadgetManager()

Description copied from interface: DashboardHolder

Gets the gadget manager.

Specified by:

getGadgetManager in interface DashboardHolder

Returns:

the gadget manager.

removeTabAt

public void removeTabAt(int index)

Overrides:

removeTabAt in class JideTabbedPane

initComponents

protected void initComponents()

createToolBarComponent

protected Container createToolBarComponent()

createDashboard

public Dashboard createDashboard(String key)

Creates the dashboard added by the add button.

Specified by:

createDashboard in interface DashboardHolder

Parameters:

key - the key for the dashboard.

Returns:

a newly created dashboard.

eventHappened

public void eventHappened(GadgetEvent e)

Description copied from interface: GadgetListener

Invoked when a Gadget event happened

Specified by:

eventHappened in interface GadgetListener

Parameters:

e - GadgetEvent

eventHappened

public void eventHappened(DashboardEvent e)

Description copied from interface: DashboardListener

Invoked when a Gadget event happened

Specified by:

eventHappened in interface DashboardListener

Parameters:

e - GadgetEvent

setSelectedIndex

public void setSelectedIndex(int index)

Overrides:

setSelectedIndex in class JideTabbedPane

getDashboardCount

public int getDashboardCount()

Gets the total number of dashboard.

Returns:

the total number of dashboard.

getDashboardAt

public Dashboard getDashboardAt(int index)

Gets the dashboard at the specified index.

Parameters:

index - the index.

Returns:

the dashboard at the specified index.

indexOfDashboard

public int indexOfDashboard(Dashboard dashboard)

Gets the index of the dashboard.

Parameters:

dashboard - the index.

Returns:

the dashboard at the specified index.

togglePalette

public void togglePalette(Component invoker)

Toggles the palette visibility.

Parameters:

invoker - the invoker that calls to this togglePalette method.

getValidParent

public Container getValidParent(Component c)

isPaletteVisible

public boolean isPaletteVisible()

Checks if the palette is visible.

Returns:

true if the palette is visible. Otherwise false.

setPaletteSide

public void setPaletteSide(int paletteSide)

Sets the palette side.

Parameters:

paletteSide - the palette side

getPaletteSide

public int getPaletteSide()

Gets the palette side. It should be WEST, EAST, NORTH or SOUTH. By default, it's SOUTH.

Specified by:

getPaletteSide in interface GadgetPaletteInstaller

Returns:

the palette side.

See Also:

setPaletteSide(int)

showPalette

public void showPalette()

showPalette

public void showPalette(Component invoker)

Shows the palette.

Specified by:

showPalette in interface GadgetPaletteInstaller

Parameters:

invoker - the invoker. In case that there are several dashboards, we need to know where to show the palette. You can pass in the Dashboard as the invoker in this case.

createGadgetPalette

protected GadgetPalette createGadgetPalette()

hidePalette

public void hidePalette()

Description copied from interface: GadgetPaletteInstaller

Hides the palette.

Specified by:

hidePalette in interface GadgetPaletteInstaller

getToolBarComponent

public Container getToolBarComponent()

setToolBar

public void setToolBar(JToolBar toolBar)

getActiveDashboard

public Dashboard getActiveDashboard()

Specified by:

getActiveDashboard in interface DashboardHolder

isUseFloatingPalette

public boolean isUseFloatingPalette()

setUseFloatingPalette

public void setUseFloatingPalette(boolean useFloatingPalette)

setToolBarAlignment

public void setToolBarAlignment(int alignment)

Sets the toolbar location. It could be SwingConstants.LEADING or SwingConstants.TRAILING. If leading, it will appear before the tabs.Otherwise, it will be after the tabs.

Parameters:

alignment - the toolbar alignment

getToolBarAlignment

public int getToolBarAlignment()

Gets the toolbar alignment. It will return SwingConstants.LEADING or SwingConstants.TRAILING or -1 if there is no toolbar installed.

Returns:

the toolbar alignment.

getImageIcon

protected ImageIcon getImageIcon(String name)

Gets the image icons that is used in PropertyPane. By default it will use IconsFactory to get the image icons.

Subclass can override this method to provide their own icon. The the value of the name parameter will be either "icons/add.png" or "icons/property.png".

Parameters:

name - the icon name

Returns:

the image icon of a name.

getResourceString

public String getResourceString(String key)

Gets the localized string from resource bundle. Subclass can override it to provide its own string. Available keys are defined in dashboard.properties.

Overrides:

getResourceString in class JideTabbedPane

Parameters:

key - the resource key.

Returns:

the localized string.