org.mdiutil.swing

Class PropertyEditor

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.mdiutil.swing.PropertyEditor

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, TableModelListener

public class PropertyEditor
extends JPanel
implements TableModelListener

User-interface component that presents datas in a two-dimensional table format. It can be used to show and modify every types of properties. There is only two columns in this Table:

• the left column shows the name of the property to be shown
• the right column shows the value of this property to edit. All editors managed by the {#link ExtendedCellEditor} class can be used

It extends the functionalities of the generic JTable component by allowing to:

• add every type of editor / renderer for each row, providing that they are JComponents managed by the {#link ExtendedCellEditor} class

The process of the creation of a PropertySelector must follow these rules :

• create a new PropertySelector
• add all the properties by the addProperty(JComponent, Object, String) method
• show the Table by the setVisible(boolean) method

The component can then be used as any JPanel. Note: Events fired by each rows are managed by the editor added in the the row by the addProperty(JComponent, Object, String) method.

Example

  String[] fill_values = {"NONE", "HORIZONTAL", "VERTICAL VALUE", "BOTH"};
  JComboBox cb = new JComboBox(fill_values);
  cb.setSelectedItem("VERTICAL VALUE");
  JTextField tf = new JTextField("2");

  PropertyEditor p = new PropertyEditor();
  p.addProperty(cb, "VERTICAL VALUE", "combo box");
  p.addProperty(tf, "2", "text");
  p.setVisible(true);
 

See Also:

ExtendedCellEditor, ExtendedCellEditorAdaptor, 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
PropertyEditor() Create a new editor with default parameters.
PropertyEditor(String name) Create a new editor and associate it with a name.
PropertyEditor(String name, String property, String value) Create a new editor and customize the columns names for properties and values.

Method Summary

Modifier and Type	Method and Description
void	addProperty(JComponent co, Object value, String name) Add a new Property edited by the desired JComponent to the table.
int	getColumnWidth(int col) Return the width of one colum.
JComponent	getComponentAt(int row) Return the component at a specified row.
AbstractTableModel	getModel() Return the underlying table model.
Dimension	getPreferredSize()
boolean	isEditable() Return true if this editor is editable.
void	reset() Reset the content of the PropertyEditor.
void	setColumnWidth(int col, int width) Set the width of one colum.
void	setEditable(boolean edit) Set the editable property of this editor.
void	setName(String name) Set the name of this editor.
void	setVisible(boolean bool)
void	tableChanged(TableModelEvent ev) Do nothing by default.
String	toString() Return the name of the Editor.
void	updateUI()

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI

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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, 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, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, 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, 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, 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, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyEditor

public PropertyEditor()

Create a new editor with default parameters.

• default name : Property Editor
• default column names :
  • properties column : Property
  • values column : Value

PropertyEditor

public PropertyEditor(String name)

Create a new editor and associate it with a name.

Parameters:

name - the name of the editor.

PropertyEditor

public PropertyEditor(String name,
                      String property,
                      String value)

Create a new editor and customize the columns names for properties and values.

Parameters:

name - the name of the editor (see toString())

property - the property column name

value - the value column name

Method Detail

addProperty

public void addProperty(JComponent co,
                        Object value,
                        String name)

Add a new Property edited by the desired JComponent to the table. Example :

   String[] fill_values = { "NONE", "HORIZONTAL", "VERTICAL VALUE","BOTH" };
   JComboBox cb = new JComboBox(fill_values);
   cb.setSelectedItem("VERTICAL VALUE");
   p.addProperty(cb, cb.getSelectedItem(), "property name");
 

In this example, a new property is created with a JComboBox. Remarks:

• It is necessary to provide a value for the property even if the JComponent already have one, as there is no standard way of getting the current value of a JComponent used for user modification. You should then be aware to put this value in the property editor, else the value presented when not in editing mode will be different from the value presented in editing mode
• Only the components managed by the ExtendedCellEditor class are allowed

Parameters:

co - the JComponent used for the property

value - the initial value for the property

name - the name of the property

updateUI

public void updateUI()

Overrides:

updateUI in class JPanel

toString

public String toString()

Return the name of the Editor. The default name is ""Property Editor".

Overrides:

toString in class Component

getComponentAt

public JComponent getComponentAt(int row)

Return the component at a specified row.

Parameters:

row - the row

Returns:

the component (or null if the row does not exist)

tableChanged

public void tableChanged(TableModelEvent ev)

Do nothing by default.

Specified by:

tableChanged in interface TableModelListener

getColumnWidth

public int getColumnWidth(int col)

Return the width of one colum.

Parameters:

col - the colum index

Returns:

the width of one colum

getModel

public AbstractTableModel getModel()

Return the underlying table model.

Returns:

the underlying table model

setColumnWidth

public void setColumnWidth(int col,
                           int width)

Set the width of one colum.

Parameters:

col - the colum index

width - the colum width

setEditable

public void setEditable(boolean edit)

Set the editable property of this editor.

Parameters:

edit - true if this Editor is editable

setName

public void setName(String name)

Set the name of this editor.

Overrides:

setName in class Component

Parameters:

name - the Editor name

isEditable

public boolean isEditable()

Return true if this editor is editable.

Returns:

true if this editor is editable

getPreferredSize

public Dimension getPreferredSize()

Overrides:

getPreferredSize in class JComponent

reset

public void reset()

Reset the content of the PropertyEditor. This can be used after the PropertyEditor has been made visible, and you want to add or remove properties.

setVisible

public void setVisible(boolean bool)

Overrides:

setVisible in class JComponent