org.carewebframework.shell.designer

Class PropertyGrid

java.lang.Object

org.carewebframework.shell.designer.PropertyGrid

All Implemented Interfaces:

org.fujion.ancillary.IAutoWired

public class PropertyGrid
extends Object
implements org.fujion.ancillary.IAutoWired

Dialog for managing property values of UI elements within the designer. Each editable property of the target UI element is presented as a row in the grid with its associated property editor.

Constructor Summary

Constructors

Constructor and Description
PropertyGrid()

Method Summary

Modifier and Type	Method and Description
protected PropertyEditorBase<?>	addPropertyEditor(PropertyInfo propInfo, boolean append) Adds a property editor to the grid for the specified property definition.
void	afterInitialized(org.fujion.component.BaseComponent comp) Initializes the property grid.
protected boolean	commitChanges(boolean commit) Commit or revert all pending changes to the target object.
static PropertyGrid	create(ElementBase target, org.fujion.component.BaseComponent parent) Creates a property grid for the given target UI element.
static PropertyGrid	create(ElementBase target, org.fujion.component.BaseComponent parent, boolean embedded) Creates a property grid for the given target UI element.
PropertyEditorBase<?>	findEditor(String propName, boolean select) Returns the editor associated with the named property, or null if none found.
int	getEditorCount() Returns number of editors in this property grid.
boolean	getPropertiesModified()
Object	getTarget() Returns the target object.
org.fujion.component.Window	getWindow()
boolean	hasPendingChanges() Returns true if there are uncommitted edits.
void	propertyChanged()
void	setTarget(ElementBase target) Sets the target UI element for the property grid.
void	setTarget(Object target, List<PropertyInfo> props, String title) Sets the target object for the property grid.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyGrid

public PropertyGrid()

Method Detail

create

public static PropertyGrid create(ElementBase target,
                                  org.fujion.component.BaseComponent parent)

Creates a property grid for the given target UI element.

Parameters:

target - UI element whose properties are to be edited.

parent - Parent component for property grid (may be null).

Returns:

Newly created PropertyGrid instance.

create

public static PropertyGrid create(ElementBase target,
                                  org.fujion.component.BaseComponent parent,
                                  boolean embedded)

Creates a property grid for the given target UI element.

Parameters:

target - UI element whose properties are to be edited.

parent - Parent component for property grid (may be null).

embedded - If true, the property grid is embedded within another component.

Returns:

Newly created PropertyGrid instance.

afterInitialized

public void afterInitialized(org.fujion.component.BaseComponent comp)

Initializes the property grid.

Specified by:

afterInitialized in interface org.fujion.ancillary.IAutoWired

Parameters:

comp - The root component.

getWindow

public org.fujion.component.Window getWindow()

setTarget

public void setTarget(ElementBase target)

Sets the target UI element for the property grid. Iterates through the target's property definitions and presents a row for each editable property.

Parameters:

target - UI element whose properties are to be edited.

setTarget

public void setTarget(Object target,
                      List<PropertyInfo> props,
                      String title)

Sets the target object for the property grid. Iterates through the target's property definitions and presents a row for each editable property.

Parameters:

target - Object whose properties are to be edited.

props - Property list.

title - Title for editor.

addPropertyEditor

protected PropertyEditorBase<?> addPropertyEditor(PropertyInfo propInfo,
                                                  boolean append)

Adds a property editor to the grid for the specified property definition.

Parameters:

propInfo - Property definition information.

append - If true, the property editor is appended to the end of the grid. Otherwise, it is inserted at the beginning.

Returns:

The newly added property editor.

commitChanges

protected boolean commitChanges(boolean commit)

Commit or revert all pending changes to the target object.

Parameters:

commit - True to commit. False to revert.

Returns:

True if all operations completed successfully.

findEditor

public PropertyEditorBase<?> findEditor(String propName,
                                        boolean select)

Returns the editor associated with the named property, or null if none found.

Parameters:

propName - The property name.

select - If true, select editor's the containing row.

Returns:

The associated property editor (may be null).

getEditorCount

public int getEditorCount()

Returns number of editors in this property grid.

Returns:

Number of editors.

hasPendingChanges

public boolean hasPendingChanges()

Returns true if there are uncommitted edits.

Returns:

True if there are uncommitted edits.

getPropertiesModified

public boolean getPropertiesModified()

getTarget

public Object getTarget()

Returns the target object.

Returns:

The target object.

propertyChanged

public void propertyChanged()