Package jam.controlpalettes
Class BasicControlPalette
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- javax.swing.JPanel
-
- jam.controlpalettes.BasicControlPalette
-
- All Implemented Interfaces:
ControlPalette
,java.awt.image.ImageObserver
,java.awt.MenuContainer
,java.io.Serializable
,javax.accessibility.Accessible
public class BasicControlPalette extends javax.swing.JPanel implements ControlPalette
- Version:
- $Id: BasicControlPalette.java 948 2008-10-02 00:19:47Z rambaut $
- Author:
- Andrew Rambaut
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
BasicControlPalette.DisplayMode
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_OPENING_SPEED
-
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
-
-
Constructor Summary
Constructors Constructor Description BasicControlPalette(int preferredWidth)
BasicControlPalette(int preferredWidth, BasicControlPalette.DisplayMode displayMode)
BasicControlPalette(int preferredWidth, BasicControlPalette.DisplayMode displayMode, int openingSpeed)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addController(int position, Controller controller)
void
addController(Controller controller)
install a Controller into the palettevoid
addControlPaletteListener(ControlPaletteListener listener)
Add a listener to this palettevoid
fireControlsChanged()
tell listeners that the palette has changedint
getControllerCount()
java.awt.Dimension
getMaximumSize()
java.awt.Dimension
getMinimumSize()
javax.swing.JPanel
getPanel()
get the panel that encloses the control palettejava.awt.Dimension
getPreferredSize()
void
getSettings(java.util.Map<java.lang.String,java.lang.Object> settings)
Gather up all the settings from all the controls in the palette.void
initialize()
Initialize all controllers when a new document is created.void
layoutControls()
void
removeController(Controller controller)
void
removeControlPaletteListener(ControlPaletteListener listener)
Remove a listener fromm this palettevoid
setPreferredWidth(int preferredWidth)
Set the preferred width of the control panelvoid
setSettings(java.util.Map<java.lang.String,java.lang.Object> settings)
Distribute all the settings to all the controls in the palette.-
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
-
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
-
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
-
-
-
Field Detail
-
DEFAULT_OPENING_SPEED
public static final int DEFAULT_OPENING_SPEED
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BasicControlPalette
public BasicControlPalette(int preferredWidth)
-
BasicControlPalette
public BasicControlPalette(int preferredWidth, BasicControlPalette.DisplayMode displayMode)
-
BasicControlPalette
public BasicControlPalette(int preferredWidth, BasicControlPalette.DisplayMode displayMode, int openingSpeed)
-
-
Method Detail
-
getPreferredSize
public java.awt.Dimension getPreferredSize()
- Overrides:
getPreferredSize
in classjavax.swing.JComponent
-
getMaximumSize
public java.awt.Dimension getMaximumSize()
- Overrides:
getMaximumSize
in classjavax.swing.JComponent
-
getMinimumSize
public java.awt.Dimension getMinimumSize()
- Overrides:
getMinimumSize
in classjavax.swing.JComponent
-
getPanel
public javax.swing.JPanel getPanel()
Description copied from interface:ControlPalette
get the panel that encloses the control palette- Specified by:
getPanel
in interfaceControlPalette
- Returns:
- the panel
-
addController
public void addController(Controller controller)
Description copied from interface:ControlPalette
install a Controller into the palette- Specified by:
addController
in interfaceControlPalette
-
addController
public void addController(int position, Controller controller)
-
removeController
public void removeController(Controller controller)
-
getControllerCount
public int getControllerCount()
-
fireControlsChanged
public void fireControlsChanged()
Description copied from interface:ControlPalette
tell listeners that the palette has changed- Specified by:
fireControlsChanged
in interfaceControlPalette
-
addControlPaletteListener
public void addControlPaletteListener(ControlPaletteListener listener)
Description copied from interface:ControlPalette
Add a listener to this palette- Specified by:
addControlPaletteListener
in interfaceControlPalette
-
removeControlPaletteListener
public void removeControlPaletteListener(ControlPaletteListener listener)
Description copied from interface:ControlPalette
Remove a listener fromm this palette- Specified by:
removeControlPaletteListener
in interfaceControlPalette
-
layoutControls
public void layoutControls()
-
initialize
public void initialize()
Description copied from interface:ControlPalette
Initialize all controllers when a new document is created. At this point, settings can be adjusted to match the contents of the document.- Specified by:
initialize
in interfaceControlPalette
-
getSettings
public void getSettings(java.util.Map<java.lang.String,java.lang.Object> settings)
Description copied from interface:ControlPalette
Gather up all the settings from all the controls in the palette. This would usually called before saving them with the document that the palette controls.- Specified by:
getSettings
in interfaceControlPalette
-
setSettings
public void setSettings(java.util.Map<java.lang.String,java.lang.Object> settings)
Description copied from interface:ControlPalette
Distribute all the settings to all the controls in the palette. This would usually called after loading the document that the palette controls.- Specified by:
setSettings
in interfaceControlPalette
-
setPreferredWidth
public void setPreferredWidth(int preferredWidth)
Description copied from interface:ControlPalette
Set the preferred width of the control panel- Specified by:
setPreferredWidth
in interfaceControlPalette
-
-