ARoad0.Gui1
Interface CommonPropertyEditor

All Superinterfaces:
java.beans.PropertyEditor
All Known Implementing Classes:
AssociationMapPropertyEditor, BaseObjectMapPropertyEditor, CollectionPropertyEditor, GraphicViewPropertyEditor, RightMapPropertyEditor, SimplePropertyEditor, StringMapPropertyEditor, StringTwoKeysMapPropertyEditor

public interface CommonPropertyEditor
extends java.beans.PropertyEditor

This interface is responsible for displaying and editing the properties of gBase classes, by the mean of panels. It is designed to be implemented by a javax.bean.PropertyEditor, like SimplePropertyEditor or CollectionPropertyEditor. Each implementation must have a single static constructor valueOf(BaseObject _source, PropertyDescriptor _propertyDescriptor). SimplePropertyEditor is the first implementation.

See Also:
SimplePropertyEditor

Field Summary
static java.awt.Dimension BOOLEAN_FIELD_DIMENSION
          Field dimension for one boolean box without ComboBox
static java.awt.Dimension BOOLEAN_NAME_DIMENSION
          Name dimension for the boolean properties and a collection without buttons
static java.awt.Dimension BUTTON_DIMENSION
          Button dimension for SimplePropertyEditor
static java.awt.Dimension BUTTON_DIMENSION_2
          Button dimension for SimplePropertyEditor and CollectionPropertyEditor
static java.awt.Dimension BUTTON_DIMENSION_3
          Button dimension for SimplePropertyEditor
static java.awt.Dimension COLOMN_DIMENSION
          dimension of colonms for displaying a map
static java.awt.Dimension COMBOBOX_FIELD_DIMENSION
          Field dimension for one boolean box with ComboBox
static java.awt.Dimension EMPTY_FIELD_DIMENSION
          Field dimension of the empty field for a boolean or integer box.
static int HEIGHT_DIMENSION
          Height dimension for all properties
static java.awt.Dimension INT_EMPTY_FIELD_DIMENSION
          Field dimension of the empty field for an integer box: INT_FIELD_DIMENSION width + NAME_WIDTH_DIMENSION + 15, for the width
static java.awt.Dimension INT_FIELD_DIMENSION
          Field dimension for an integer box
static int LIST_HEIGHT_DIMENSION
          Height dimension for one JList scrollPane where 8 items are visible
static int LIST_WIDTH_DIMENSION
          Width dimension for one JList scrollPane
static int MAP_NAME_WIDTH_DIMENSION
          Width dimension for name in map
static java.awt.Dimension NAME_DIMENSION
          Name dimension for most of the properties
static java.awt.Dimension NAME_MAP_DIMENSION
          Name dimension for map properties
static int NAME_WIDTH_DIMENSION
          Width dimension for current name
static int NAME_WIDTH_DIMENSION_2
          Width dimension for current name of a boolean property
static java.awt.Dimension NO_BUTTON_FIELD_DIMENSION
          Field dimension for properties without View, New and Select buttons
static int NO_BUTTON_WIDTH_DIMENSION
          Width dimension for the larger label in all properties
static java.awt.Dimension ONE_BUTTON_FIELD_DIMENSION
          Field dimension for properties with one button
static java.awt.Dimension THREE_BUTTONS_FIELD_DIMENSION
          Field dimension for properties with three buttons
static java.awt.Dimension TWO_BUTTONS_FIELD_DIMENSION
          Field dimension for properties with two buttons
 
Method Summary
 void finalizeForProcess()
          Finalize the instance; the call is reserved to BeamerManager.
 java.awt.Component getCustomEditor()
          A CommonPropertyEditor makes available a full custom Component that edits its property value.
 java.lang.String getDisplayName()
          Gets the value of the display property name (not the true name, given by the property descriptor).
 java.awt.Dimension getPreferedSizeForEditing()
          Get the prefered size for the rectangle into which the value is displayed, in the component returned by PropertyEditor.getCustomEditor().
 java.beans.PropertyDescriptor getPropertyDescriptor()
          Gets the descriptor of the property.
 java.lang.Class getPropertyType()
          Gets the value of the property type, that is the Class of the returned object in getValue().
 java.lang.reflect.Method getWriteMethod()
          Gets the method on the source for updates.
 
Methods inherited from interface java.beans.PropertyEditor
addPropertyChangeListener, getAsText, getJavaInitializationString, getTags, getValue, isPaintable, paintValue, removePropertyChangeListener, setAsText, setValue, supportsCustomEditor
 

Field Detail

HEIGHT_DIMENSION

static final int HEIGHT_DIMENSION
Height dimension for all properties

See Also:
Constant Field Values

NAME_WIDTH_DIMENSION

static final int NAME_WIDTH_DIMENSION
Width dimension for current name

See Also:
Constant Field Values

NAME_WIDTH_DIMENSION_2

static final int NAME_WIDTH_DIMENSION_2
Width dimension for current name of a boolean property

See Also:
Constant Field Values

MAP_NAME_WIDTH_DIMENSION

static final int MAP_NAME_WIDTH_DIMENSION
Width dimension for name in map

See Also:
Constant Field Values

COLOMN_DIMENSION

static final java.awt.Dimension COLOMN_DIMENSION
dimension of colonms for displaying a map


NAME_DIMENSION

static final java.awt.Dimension NAME_DIMENSION
Name dimension for most of the properties


BOOLEAN_NAME_DIMENSION

static final java.awt.Dimension BOOLEAN_NAME_DIMENSION
Name dimension for the boolean properties and a collection without buttons


NAME_MAP_DIMENSION

static final java.awt.Dimension NAME_MAP_DIMENSION
Name dimension for map properties


BUTTON_DIMENSION

static final java.awt.Dimension BUTTON_DIMENSION
Button dimension for SimplePropertyEditor


BUTTON_DIMENSION_2

static final java.awt.Dimension BUTTON_DIMENSION_2
Button dimension for SimplePropertyEditor and CollectionPropertyEditor


BUTTON_DIMENSION_3

static final java.awt.Dimension BUTTON_DIMENSION_3
Button dimension for SimplePropertyEditor


NO_BUTTON_WIDTH_DIMENSION

static final int NO_BUTTON_WIDTH_DIMENSION
Width dimension for the larger label in all properties

See Also:
Constant Field Values

BOOLEAN_FIELD_DIMENSION

static final java.awt.Dimension BOOLEAN_FIELD_DIMENSION
Field dimension for one boolean box without ComboBox


COMBOBOX_FIELD_DIMENSION

static final java.awt.Dimension COMBOBOX_FIELD_DIMENSION
Field dimension for one boolean box with ComboBox


EMPTY_FIELD_DIMENSION

static final java.awt.Dimension EMPTY_FIELD_DIMENSION
Field dimension of the empty field for a boolean or integer box. Used by BeamerManager.addPropertyEditor().


INT_FIELD_DIMENSION

static final java.awt.Dimension INT_FIELD_DIMENSION
Field dimension for an integer box


INT_EMPTY_FIELD_DIMENSION

static final java.awt.Dimension INT_EMPTY_FIELD_DIMENSION
Field dimension of the empty field for an integer box: INT_FIELD_DIMENSION width + NAME_WIDTH_DIMENSION + 15, for the width


NO_BUTTON_FIELD_DIMENSION

static final java.awt.Dimension NO_BUTTON_FIELD_DIMENSION
Field dimension for properties without View, New and Select buttons


ONE_BUTTON_FIELD_DIMENSION

static final java.awt.Dimension ONE_BUTTON_FIELD_DIMENSION
Field dimension for properties with one button


TWO_BUTTONS_FIELD_DIMENSION

static final java.awt.Dimension TWO_BUTTONS_FIELD_DIMENSION
Field dimension for properties with two buttons


THREE_BUTTONS_FIELD_DIMENSION

static final java.awt.Dimension THREE_BUTTONS_FIELD_DIMENSION
Field dimension for properties with three buttons


LIST_WIDTH_DIMENSION

static final int LIST_WIDTH_DIMENSION
Width dimension for one JList scrollPane

See Also:
Constant Field Values

LIST_HEIGHT_DIMENSION

static final int LIST_HEIGHT_DIMENSION
Height dimension for one JList scrollPane where 8 items are visible

See Also:
Constant Field Values
Method Detail

getCustomEditor

java.awt.Component getCustomEditor()
A CommonPropertyEditor makes available a full custom Component that edits its property value. Override the PropertyEditor method.

Specified by:
getCustomEditor in interface java.beans.PropertyEditor
Returns:
a JPanel that will allow the user to directly edit the current property value.
See Also:
PropertyEditor.getCustomEditor()

getDisplayName

java.lang.String getDisplayName()
Gets the value of the display property name (not the true name, given by the property descriptor).

Returns:
the display name of the property.

getPropertyType

java.lang.Class getPropertyType()
Gets the value of the property type, that is the Class of the returned object in getValue().

Returns:
The type of the property.

getPropertyDescriptor

java.beans.PropertyDescriptor getPropertyDescriptor()
Gets the descriptor of the property.

Returns:
The descriptor of the property.

getWriteMethod

java.lang.reflect.Method getWriteMethod()
Gets the method on the source for updates.

Returns:
The method on the source for updates.

getPreferedSizeForEditing

java.awt.Dimension getPreferedSizeForEditing()
Get the prefered size for the rectangle into which the value is displayed, in the component returned by PropertyEditor.getCustomEditor().

Returns:
prefered size.

finalizeForProcess

void finalizeForProcess()
Finalize the instance; the call is reserved to BeamerManager.