org.softsmithy.lib.swing.customizer

Class JCustomizer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.softsmithy.lib.swing.JStyledPanel

org.softsmithy.lib.swing.customizer.AbstractCustomizer

org.softsmithy.lib.swing.customizer.JCustomizer

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, Styleable

Direct Known Subclasses:

AbstractTextCustomizer, JXIconCustomizer

public class JCustomizer
extends AbstractCustomizer

This component wraps another component to make it visually customizable. Eg. the component can be moved or resized with the mouse. Note: JCustomizer expects a JCustomizerPane as its parent. Note: For multi-selection: press the Ctrl-button while selecting. Note: If you're interested in the values of the properties "x", "y", "width" and "height", then you might want to register a CustomizerListener in addition to PropertyChangeListeners to listen for all changes, absolute and relative ones.

Author:

puce

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

Fields inherited from class javax.swing.JComponent

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

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

Constructors

Constructor and Description
JCustomizer() Creates a new instance of this class.
JCustomizer(JComponent component) Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
void	addActionListener(ActionListener l) Adds an ActionListener.
void	addCustomizerListener(CustomizerListener listener) Adds a CustomizerListener.
void	applyBorder(Border border) Applys a border to this customizer.
void	fireActionEvent(ActionEvent ev) Fires an ActionEvent.
void	fireCustomizerResetBoundsRel(CustomizerEvent e) Fires a CustomizerEvent to notify the CustomizerListeners that the bounds of this customizer have been relatively changed.
void	fireCustomizerReshapeRel(CustomizerEvent e) Fires a CustomizerEvent to notify the CustomizerListeners this customizer have been relatively reshaped.
JComponent	getComponent() Gets the wrapped component.
JPanel	getGlassPane() Gets the glass pane over the wrapped component.
Color	getNormalBorderColor() Gets the color of the border of the normal state.
JCustomizerPane	getParentCustomizerPane() Gets the parent JCustomizerPane.
Color	getSelectedBorderColor() Gets the color of the border of the selected state.
StateManager	getStateManager() Gets the state manager.
String	getToolTipText() Returns the tooltip string that has been set with setToolTipText.
boolean	isUsingDefaultNormalBorderColor() Tells if this customizer is using the default color of the border of the normal state.
boolean	isUsingDefaultSelectedBorderColor() Tells if this customizer is using the default color of the border of the selected state.
void	removeActionListener(ActionListener l) Removes an ActionListener.
void	removeCustomizerListener(CustomizerListener listener) Removes a CustomizerListener.
void	reshapeRel(int dx, int dy, int dwidth, int dheight) Relatively reshapes this customizer.
protected void	reshapeRelOnly(int dx, int dy, int dwidth, int dheight) Relatively reshapes this customizer without firing an event.
void	setBoundsRel(int dx, int dy, int dwidth, int dheight) Relatively changes the bounds of this customizer.
protected void	setBoundsRelOnly(int dx, int dy, int dwidth, int dheight) Relatively changes the bounds of this customizer without firing an event.
void	setComponent(JComponent component) Sets the wrapped component.
void	setDefaultBackground(Color bg)
void	setDefaultFont(Font font)
void	setDefaultForeground(Color fg)
void	setDefaultOpaque(boolean isOpaque)
void	setHeight(int height) Sets the height.
protected void	setStateManager(StateManager manager) Sets the state manager.
void	setToolTipText(String text) Registers the text to display in a tool tip.
void	setUsingDefaultNormalBorderColor(boolean usingDefaultNormalBorderColor) Specifies if this customizer should use the default or a custom color of the border of the normal state.
void	setUsingDefaultSelectedBorderColor(boolean usingDefaultSelectedBorderColor) Specifies if this customizer should use the default or a custom color of the border of the selected state.
void	setWidth(int width) Sets the width.
void	setX(int x) Sets the x coordinate.
void	setY(int y) Sets the y coordinate.

Methods inherited from class org.softsmithy.lib.swing.customizer.AbstractCustomizer

getCommonCustomizableProperties, getCustomizableProperties, setCustomizableProperties

Methods inherited from class org.softsmithy.lib.swing.JStyledPanel

getBackground, getDefaultBackground, getDefaultFont, getDefaultForeground, getFont, getForeground, getNoneStyle, getParentStyle, getStyle, isDefaultOpaque, isOpaque, setBackground, setFont, setForeground, setOpaque, setStyle

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, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, 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, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.softsmithy.lib.swing.style.Styleable

addHierarchyListener, getParent, removeHierarchyListener

Constructor Detail

JCustomizer

public JCustomizer()

Creates a new instance of this class.

JCustomizer

public JCustomizer(JComponent component)

Creates a new instance of this class.

Parameters:

component - the wrapped component

Method Detail

getComponent

public JComponent getComponent()

Gets the wrapped component.

Returns:

the wrapped component

setComponent

public void setComponent(JComponent component)

Sets the wrapped component.

Parameters:

component - the wrapped component

getStateManager

public StateManager getStateManager()

Gets the state manager.

Returns:

the state manager

setStateManager

protected void setStateManager(StateManager manager)

Sets the state manager.

Parameters:

manager - the state manager

reshapeRel

public void reshapeRel(int dx,
                       int dy,
                       int dwidth,
                       int dheight)

Relatively reshapes this customizer.
This will ask the parent to relayout its components.
Fires a CustomizerEvent (relative coordinates) but no PropertyChangeEvents (absolute coordinates)!

Parameters:

dx - delta x

dy - delta y

dwidth - delta width

dheight - delta height

reshapeRelOnly

protected void reshapeRelOnly(int dx,
                              int dy,
                              int dwidth,
                              int dheight)

Relatively reshapes this customizer without firing an event.
This will ask the parent to relayout its components.

Parameters:

dx - delta x

dy - delta y

dwidth - delta width

dheight - delta height

setBoundsRel

public void setBoundsRel(int dx,
                         int dy,
                         int dwidth,
                         int dheight)

Relatively changes the bounds of this customizer.
This will NOT ask the parent to relayout its components.
Fires a CustomizerEvent (relative coordinates) but no PropertyChangeEvents (absolute coordinates)!

Parameters:

dx - delta x

dy - delta y

dwidth - delta width

dheight - delta height

setBoundsRelOnly

protected void setBoundsRelOnly(int dx,
                                int dy,
                                int dwidth,
                                int dheight)

Relatively changes the bounds of this customizer without firing an event.
This will NOT ask the parent to relayout its components.

Parameters:

dx - delta x

dy - delta y

dwidth - delta width

dheight - delta height

addCustomizerListener

public void addCustomizerListener(CustomizerListener listener)

Adds a CustomizerListener.

Parameters:

listener - a CustomizerListener

removeCustomizerListener

public void removeCustomizerListener(CustomizerListener listener)

Removes a CustomizerListener.

Parameters:

listener - a CustomizerListener

fireCustomizerResetBoundsRel

public void fireCustomizerResetBoundsRel(CustomizerEvent e)

Fires a CustomizerEvent to notify the CustomizerListeners that the bounds of this customizer have been relatively changed.

Parameters:

e - the CustomizerEvent

fireCustomizerReshapeRel

public void fireCustomizerReshapeRel(CustomizerEvent e)

Fires a CustomizerEvent to notify the CustomizerListeners this customizer have been relatively reshaped.

Parameters:

e - the CustomizerEvent

getGlassPane

public JPanel getGlassPane()

Gets the glass pane over the wrapped component.

Returns:

the glass pane over the wrapped component

setToolTipText

public void setToolTipText(String text)

Registers the text to display in a tool tip. The text displays when the cursor lingers over the component.

See How to Use Tool Tips in The Java Tutorial for further documentation.

Overrides:

setToolTipText in class JComponent

Parameters:

text - the string to display; if the text is null, the tool tip is turned off for this component

See Also:

JComponent.TOOL_TIP_TEXT_KEY

applyBorder

public void applyBorder(Border border)

Applys a border to this customizer.
Usually you will use this method rather than setBorder.

Parameters:

border - a border

setX

public void setX(int x)

Sets the x coordinate.
Fires a PropertyChangeEvent (absolute coordinates) but no CustomizerEvent (relative coordinates)!

Parameters:

x - the x coordinate

setY

public void setY(int y)

Sets the y coordinate.
Fires a PropertyChangeEvent (absolute coordinates) but no CustomizerEvent (relative coordinates)!

Parameters:

y - the y coordinate

setWidth

public void setWidth(int width)

Sets the width.
Fires a PropertyChangeEvent (absolute coordinates) but no CustomizerEvent (relative coordinates)!

Parameters:

width - the width

setHeight

public void setHeight(int height)

Sets the height.
Fires a PropertyChangeEvent (absolute coordinates) but no CustomizerEvent (relative coordinates)!

Parameters:

height - the height

getToolTipText

public String getToolTipText()

Returns the tooltip string that has been set with setToolTipText.

Overrides:

getToolTipText in class JComponent

Returns:

the text of the tool tip

See Also:

JComponent.TOOL_TIP_TEXT_KEY

setDefaultBackground

public void setDefaultBackground(Color bg)

Specified by:

setDefaultBackground in interface Styleable

Overrides:

setDefaultBackground in class JStyledPanel

setDefaultForeground

public void setDefaultForeground(Color fg)

Specified by:

setDefaultForeground in interface Styleable

Overrides:

setDefaultForeground in class JStyledPanel

setDefaultFont

public void setDefaultFont(Font font)

Specified by:

setDefaultFont in interface Styleable

Overrides:

setDefaultFont in class JStyledPanel

setDefaultOpaque

public void setDefaultOpaque(boolean isOpaque)

Specified by:

setDefaultOpaque in interface Styleable

Overrides:

setDefaultOpaque in class JStyledPanel

getParentCustomizerPane

public JCustomizerPane getParentCustomizerPane()

Gets the parent JCustomizerPane.
Note: If the parent is not an instance of JCustomizerPane a ClassCastException will be thrown!

Returns:

the parent JCustomizerPane

addActionListener

public void addActionListener(ActionListener l)

Adds an ActionListener.

Parameters:

l - an ActionListener

removeActionListener

public void removeActionListener(ActionListener l)

Removes an ActionListener.

Parameters:

l - an ActionListener

fireActionEvent

public void fireActionEvent(ActionEvent ev)

Fires an ActionEvent.

Parameters:

ev - an ActionEvent

getNormalBorderColor

public Color getNormalBorderColor()

Gets the color of the border of the normal state.

Returns:

the color of the border of the normal state

getSelectedBorderColor

public Color getSelectedBorderColor()

Gets the color of the border of the selected state.

Returns:

the color of the border of the selected state

isUsingDefaultNormalBorderColor

public boolean isUsingDefaultNormalBorderColor()

Tells if this customizer is using the default color of the border of the normal state.

Returns:

true if the default color is used, else false

setUsingDefaultNormalBorderColor

public void setUsingDefaultNormalBorderColor(boolean usingDefaultNormalBorderColor)

Specifies if this customizer should use the default or a custom color of the border of the normal state.

Parameters:

usingDefaultNormalBorderColor - true if the default color should be used, else false

isUsingDefaultSelectedBorderColor

public boolean isUsingDefaultSelectedBorderColor()

Tells if this customizer is using the default color of the border of the selected state.

Returns:

true if the default color is used, else false

setUsingDefaultSelectedBorderColor

public void setUsingDefaultSelectedBorderColor(boolean usingDefaultSelectedBorderColor)

Specifies if this customizer should use the default or a custom color of the border of the selected state.

Parameters:

usingDefaultSelectedBorderColor - true if the default color should be used, else false