fr.ove.palette.swing
Class Palette

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  fr.ove.palette.swing.Palette

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

Direct Known Subclasses:

BasicOperatorsPalette, IntegralPalette, LogPalette, NonBasicOperatorsPalette, ProdSumPalette, TrigoPalette

public class Palette

extends javax.swing.JPanel

The palette.
The palette throws @see PaletteEvent to the registered @see PaletteEventListener.
These events contain a @see PaletteInfo object which contains relevant information for the listeners.

The palette can be made of objects which have the addActionListener(ActionListener l). Only objects such as buttons are relevant in a palette, but if you want to add other kind of objects having the addActionListener(ActionListener l) method, what you have to do is the something like what is following:

• Palette palette = new Palette(...);
• MyStuff stuff = new MyStuff(...); // Which extends java.awt.Component
• palette.getCorrespondance().put(stuff, new PalettreInfo(...));
• stuff.addActionListener(palette.getActionListener()); // MyStuff must implement this methods (at least) to send ActionEvent to objects which want to be informed of actions on it (such as button, ... see before)
• palette.add(stuff);

Or you can subclass this class and implement your own addStuffToPalette(...) doing the given pice of code.

Version:

1.0 19/09/1999

Author:

© 1999 DIRAT Laurent

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

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

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

Palette(byte constraint, int nbElement)
The contstructor.

Method Summary

void	addButtonToPalette(javax.swing.JButton button, PaletteInfo paletteInfo) Adds a button into the palette with the specified information (@see PaletteInfo).
void	addPaletteListener(PaletteListener paletteListener) Registers another listener to be informed of changes of the palette.
void	firePaletteEvent(PaletteEvent paletteEvent) Fires a PaletteEvent event to registered listeners.
java.awt.event.ActionListener	getActionListener() Returns the @see ActionListener share by the different instance of Palette which is in charge of throwing @see PaletteEvent to all the listeners.
java.util.Hashtable	getCorrespondance() Returns the correspondances (i.e. the hastable) of the stuff in the palette and their associated relevant information to send to the listener of the instance.
void	removePaletteListener(PaletteListener paletteListener) Removes a listener.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

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

add, add, add, add, add, addContainerListener, addImpl, 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, remove, remove, removeAll, 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

Constructor Detail

Palette

public Palette(byte constraint,
               int nbElement)

The contstructor.

Parameters:

constraint - the constraint (PaletteLayout.ROW_CONSTRAINT or PaletteLayout.COLUMN_CONSTRAINT) for ordering the components in the palette.

nbElement - the number max of element allowed by row (resp. column) with the PaletteLayout.ROW_CONSTRAINT (resp. PaletteLayout.COLUMN_CONSTRAINT) constraint.

Method Detail

addButtonToPalette

public void addButtonToPalette(javax.swing.JButton button,
                               PaletteInfo paletteInfo)

Adds a button into the palette with the specified information (@see PaletteInfo).

Parameters:

button - the button to add into the palette.

paletteInfo - the specified palette information

getCorrespondance

public java.util.Hashtable getCorrespondance()

Returns the correspondances (i.e. the hastable) of the stuff in the palette and their associated relevant information to send to the listener of the instance.

getActionListener

public java.awt.event.ActionListener getActionListener()

Returns the @see ActionListener share by the different instance of Palette which is in charge of throwing @see PaletteEvent to all the listeners.

addPaletteListener

public void addPaletteListener(PaletteListener paletteListener)

Registers another listener to be informed of changes of the palette.

Parameters:

paletteListener - a listener to add.

removePaletteListener

public void removePaletteListener(PaletteListener paletteListener)

Removes a listener.

Parameters:

paletteListener - the listener to remove.

firePaletteEvent

public void firePaletteEvent(PaletteEvent paletteEvent)

Fires a PaletteEvent event to registered listeners.

Parameters:

paletteEvent - event encapsulating relevant information.