com.jidesoft.dashboard
Class SingleDashboardHolder

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.jidesoft.dashboard.Dashboard
                      com.jidesoft.dashboard.SingleDashboardHolder

All Implemented Interfaces:

DashboardHolder, GadgetPaletteInstaller, ImageObserver, MenuContainer, Serializable, Accessible, Scrollable

public class SingleDashboardHolder
extends Dashboard
implements GadgetPaletteInstaller, DashboardHolder

SingleDashboardHolder creates a single dashboard that implements DashboardHolder interface.

See Also:

Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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

protected GadgetManager

_gadgetManager

Fields inherited from class com.jidesoft.dashboard.Dashboard

COMPONENT_MAXIMIZED, H_GAP, PROPERTY_COLUMN_COUNT, PROPERTY_ICON, PROPERTY_KEY, PROPERTY_TITLE, V_GAP

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

SingleDashboardHolder()

SingleDashboardHolder(GadgetManager gadgetManager)

SingleDashboardHolder(String key)

SingleDashboardHolder(String key, String title)

SingleDashboardHolder(String key, String title, int columnCount)

Method Summary

Dashboard	createDashboard(String key)
protected GadgetPalette	createGadgetPalette()
Dashboard	getActiveDashboard()
GadgetManager	getGadgetManager() Gets the gadget manager.
int	getPaletteSide() Gets the palette side.
Container	getValidParent(Component c)
void	hidePalette() Hides the palette.
protected void	initDashboard() Initializes the dashboard.
boolean	isPaletteVisible() Checks if the palette is visible.
boolean	isUseFloatingPalette()
void	setPaletteSide(int paletteSide) Sets the palette side.
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.dashboard.Dashboard

addPlaceHolder, addPlaceHolder, addPlaceHolder, createDefaultPlaceHolder, createMaximizedGadgetContainer, createNormalGadgetContainer, createNormalGadgetContainer, createSubpanel, doLayout, getColumnCount, getColumnIndex, getComponentAtLeft, getComponentAtTop, getComponentConstraints, getDashboardLayout, getDefaultColumnCount, getGadgetComponents, getGadgetContainer, getIcon, getImageIcon, getKey, getLayoutAdapter, getPredefinedLayout, getPreferredScrollableViewportSize, getRowIndex, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSettings, getTitle, isColumnResizable, isPredefinedLayoutSet, isRowResizable, isShowGripper, maximizeGadget, maximizeGadget, maximizeGadgetComponent, maximizeGadgetComponent, maximizeGadgetComponent, removePredefinedGadgetPosition, restoreGadget, restoreGadgetComponent, setColumnCount, setColumnResizable, setDefaultColumnCount, setIcon, setKey, setLayoutAdapter, setPredefinedLayout, setRowResizable, setSettings, setShowGripper, setTitle, showMaximizedGadgetContainer, showNormalGadgetContainer

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

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

Field Detail

_gadgetManager

protected GadgetManager _gadgetManager

Constructor Detail

SingleDashboardHolder

public SingleDashboardHolder()

SingleDashboardHolder

public SingleDashboardHolder(GadgetManager gadgetManager)

SingleDashboardHolder

public SingleDashboardHolder(String key)

SingleDashboardHolder

public SingleDashboardHolder(String key,
                             String title)

SingleDashboardHolder

public SingleDashboardHolder(String key,
                             String title,
                             int columnCount)

Method Detail

initDashboard

protected void initDashboard()

Description copied from class: Dashboard

Initializes the dashboard. Subclass can override it. By default, we set the background, set the border.

Overrides:

initDashboard in class Dashboard

getGadgetManager

public GadgetManager getGadgetManager()

Description copied from interface: DashboardHolder

Gets the gadget manager.

Specified by:

getGadgetManager in interface DashboardHolder

Returns:

the gadget manager.

getActiveDashboard

public Dashboard getActiveDashboard()

Specified by:

getActiveDashboard in interface DashboardHolder

createDashboard

public Dashboard createDashboard(String key)

Specified by:

createDashboard in interface DashboardHolder

isUseFloatingPalette

public boolean isUseFloatingPalette()

setUseFloatingPalette

public void setUseFloatingPalette(boolean useFloatingPalette)

createGadgetPalette

protected GadgetPalette createGadgetPalette()

getValidParent

public Container getValidParent(Component c)

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.

hidePalette

public void hidePalette()

Description copied from interface: GadgetPaletteInstaller

Hides the palette.

Specified by:

hidePalette in interface GadgetPaletteInstaller

isPaletteVisible

public boolean isPaletteVisible()

Checks if the palette is visible.

Returns:

true if the palette is visible. Otherwise false.

togglePalette

public void togglePalette(Component invoker)

Toggles the palette visibility.

Parameters:

invoker - the invoker that calls to this togglePalette method.