Compiere Looks 1.2.1

org.compiere.plaf
Class CompiereColorEditor

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--javax.swing.JDialog
                                |
                                +--org.compiere.plaf.CompiereColorEditor
All Implemented Interfaces:
Accessible, ActionListener, EventListener, ImageObserver, MenuContainer, PropertyEditor, RootPaneContainer, Serializable, WindowConstants

public class CompiereColorEditor
extends JDialog
implements ActionListener, PropertyEditor

Compiere Color Editor

Version:
$Id: CompiereColorEditor.java,v 1.9 2002/09/01 22:34:37 jjanke Exp $
Author:
Jorg Janke
See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.swing.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
CompiereColorEditor(Dialog owner, CompiereColor color)
          Create CompiereColor Dialog with color
CompiereColorEditor(Frame owner, CompiereColor color)
          Create CompiereColor Dialog with color
 
Method Summary
 void actionPerformed(ActionEvent e)
          Action Listener
 void addPropertyChangeListener(PropertyChangeListener listener)
          Register a listener for the PropertyChange event.
 String getAsText()
          Gets the property value as text.
 CompiereColor getColor()
          Get Color
 Component getCustomEditor()
          A PropertyEditor may choose to make available a full custom Component that edits its property value.
 String getJavaInitializationString()
          This method is intended for use when generating Java code to set the value of the property.
 String[] getTags()
          If the property value must be one of a set of known tagged values, then this method should return an array of the tags.
 Object getValue()
          Gets the property value.
 boolean isPaintable()
          Determines whether this property editor is paintable.
 boolean isSaved()
          Was the selection saved
 void paintValue(Graphics gfx, Rectangle box)
          Paint a representation of the value into a given area of screen real estate.
 void removePropertyChangeListener(PropertyChangeListener listener)
          Remove a listener for the PropertyChange event.
 void setAsText(String text)
          Set the property value by parsing a given String.
 void setColor(CompiereColor color)
          Set Color and update UI
 void setValue(Object value)
          Set (or change) the object that is to be edited.
static CompiereColor showDialog(Dialog owner, CompiereColor color)
          Get Background CompiereColor
static CompiereColor showDialog(Frame owner, CompiereColor color)
          Get Background CompiereColor
 boolean supportsCustomEditor()
          Determines whether this property editor supports a custom editor.
 
Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Dialog
addNotify, dispose, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, toBack, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CompiereColorEditor

public CompiereColorEditor(Frame owner,
                           CompiereColor color)
Create CompiereColor Dialog with color

Parameters:
owner - owner
color - Start Color

CompiereColorEditor

public CompiereColorEditor(Dialog owner,
                           CompiereColor color)
Create CompiereColor Dialog with color

Parameters:
owner - owner
color - Start Color
Method Detail

showDialog

public static CompiereColor showDialog(Frame owner,
                                       CompiereColor color)
Get Background CompiereColor

Parameters:
owner - owner
color - optional initial color
Returns:
CompiereColor

showDialog

public static CompiereColor showDialog(Dialog owner,
                                       CompiereColor color)
Get Background CompiereColor

Parameters:
owner - owner
color - optional initial color
Returns:
CompiereColor

actionPerformed

public void actionPerformed(ActionEvent e)
Action Listener

Specified by:
actionPerformed in interface ActionListener
Parameters:
e - event

setColor

public void setColor(CompiereColor color)
Set Color and update UI

Parameters:
color - color

getColor

public CompiereColor getColor()
Get Color

Returns:
Color, when saved - else null

isSaved

public boolean isSaved()
Was the selection saved

Returns:
true if saved

setValue

public void setValue(Object value)
Set (or change) the object that is to be edited. Primitive types such as "int" must be wrapped as the corresponding object type such as "java.lang.Integer".

Specified by:
setValue in interface PropertyEditor
Parameters:
value - The new target object to be edited. Note that this object should not be modified by the PropertyEditor, rather the PropertyEditor should create a new object to hold any modified value.

getValue

public Object getValue()
Gets the property value.

Specified by:
getValue in interface PropertyEditor
Returns:
The value of the property. Primitive types such as "int" will be wrapped as the corresponding object type such as "java.lang.Integer".

isPaintable

public boolean isPaintable()
Determines whether this property editor is paintable.

Specified by:
isPaintable in interface PropertyEditor
Returns:
True if the class will honor the paintValue method.

paintValue

public void paintValue(Graphics gfx,
                       Rectangle box)
Paint a representation of the value into a given area of screen real estate. Note that the propertyEditor is responsible for doing its own clipping so that it fits into the given rectangle.

If the PropertyEditor doesn't honor paint requests (see isPaintable) this method should be a silent noop.

The given Graphics object will have the default font, color, etc of the parent container. The PropertyEditor may change graphics attributes such as font and color and doesn't need to restore the old values.

Specified by:
paintValue in interface PropertyEditor
Parameters:
gfx - Graphics object to paint into.
box - Rectangle within graphics object into which we should paint.

getJavaInitializationString

public String getJavaInitializationString()
This method is intended for use when generating Java code to set the value of the property. It should return a fragment of Java code that can be used to initialize a variable with the current property value.

Example results are "2", "new Color(127,127,34)", "Color.orange", etc.

Specified by:
getJavaInitializationString in interface PropertyEditor
Returns:
A fragment of Java code representing an initializer for the current value.

getAsText

public String getAsText()
Gets the property value as text.

Specified by:
getAsText in interface PropertyEditor
Returns:
The property value as a human editable string.

Returns null if the value can't be expressed as an editable string.

If a non-null value is returned, then the PropertyEditor should be prepared to parse that string back in setAsText().


setAsText

public void setAsText(String text)
               throws IllegalArgumentException
Set the property value by parsing a given String. May raise java.lang.IllegalArgumentException if either the String is badly formatted or if this kind of property can't be expressed as text.

Specified by:
setAsText in interface PropertyEditor
Parameters:
text - The string to be parsed.
Throws:
IllegalArgumentException

getTags

public String[] getTags()
If the property value must be one of a set of known tagged values, then this method should return an array of the tags. This can be used to represent (for example) enum values. If a PropertyEditor supports tags, then it should support the use of setAsText with a tag value as a way of setting the value and the use of getAsText to identify the current value.

Specified by:
getTags in interface PropertyEditor
Returns:
The tag values for this property. May be null if this property cannot be represented as a tagged value.

getCustomEditor

public Component getCustomEditor()
A PropertyEditor may choose to make available a full custom Component that edits its property value. It is the responsibility of the PropertyEditor to hook itself up to its editor Component itself and to report property value changes by firing a PropertyChange event.

The higher-level code that calls getCustomEditor may either embed the Component in some larger property sheet, or it may put it in its own individual dialog, or ...

Specified by:
getCustomEditor in interface PropertyEditor
Returns:
A java.awt.Component that will allow a human to directly edit the current property value. May be null if this is not supported.

supportsCustomEditor

public boolean supportsCustomEditor()
Determines whether this property editor supports a custom editor.

Specified by:
supportsCustomEditor in interface PropertyEditor
Returns:
True if the propertyEditor can provide a custom editor.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)
Register a listener for the PropertyChange event. When a PropertyEditor changes its value it should fire a PropertyChange event on all registered PropertyChangeListeners, specifying the null value for the property name and itself as the source.

Specified by:
addPropertyChangeListener in interface PropertyEditor
Overrides:
addPropertyChangeListener in class Window
Parameters:
listener - An object to be invoked when a PropertyChange event is fired.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)
Remove a listener for the PropertyChange event.

Specified by:
removePropertyChangeListener in interface PropertyEditor
Overrides:
removePropertyChangeListener in class Component
Parameters:
listener - The PropertyChange listener to be removed.

Compiere Looks 1.2.1

Copyright (c) 1999-2003 ComPiere, Inc. - Author: Jorg Janke