com.sage.swt.client.customization
Interface PropertyEditor

All Known Subinterfaces:

CompoundPropertyEditor

All Known Implementing Classes:

AbstractChartAxisPropertyEditor, AbstractTransTextPropertyEditor, ApplicationMenuPropertyEditor, BooleanPropertyEditor, CharPropertyEditor, ContextMenuItemsPropertyEditor, ContextMenuTypePropertyEditor, EnumPropertyEditor, ExtFilterFindersProperty.ExtFilterFindersPropertyEditor, ExtFilterFiscalProperty.ExtFilterFiscalPropertyEditor, ExtFilterPropertyBindingProperty.ExtFilterPropertyBindingPropertyEditor, HorizontalAlignmentPropertyEditor, IntegerPropertyEditor, NavigatorPanelLevelProperty.NavigatorPanelLevelPropertyEditor, NumberDomainPropertyEditor, ProjectTypePropertyEditor, SortFieldPropertyEditor, SortPropertyBindingPropertyEditor, StringPropertyEditor, TableTypePropertyEditor, ThemePropertyEditor, VerticalAlignmentPropertyEditor

public interface PropertyEditor

Property editor interface. The UI designer uses property editors to allow people to change the property values for SWT widgets.

Method Summary

java.lang.Object	convertStringToValue(java.lang.String s) Converts the string representation of the property's value to the actual value.
java.lang.String	convertValueToString(java.lang.Object value) Converts the property's value to the string representation of that value.
java.lang.String	getDisplayName() Gets the property's display name (such as "Read-Only").
java.lang.String	getTagName() Gets the property's tag name (such as "readOnly").
PropertyEditorWidget	getWidget(Property property, SwtWidget swtWidget, SwtErrorStack errorStack) Gets the property editor widget that will allow you to edit the properties for the specified property on the specified SWT widget (swtWidget).

Method Detail

getTagName

java.lang.String getTagName()

Gets the property's tag name (such as "readOnly"). This tag name gets stored in the declarative information (i.e. it may be the XML attribute name or element name).

Returns:

The property's tag name.

getDisplayName

java.lang.String getDisplayName()

Gets the property's display name (such as "Read-Only"). The UI designer will show the display name for the property.

Returns:

The property's display name.

convertValueToString

java.lang.String convertValueToString(java.lang.Object value)

Converts the property's value to the string representation of that value.

Parameters:

value - The property's value.

Returns:

The string representation of the property's value.

convertStringToValue

java.lang.Object convertStringToValue(java.lang.String s)

Converts the string representation of the property's value to the actual value.

Parameters:

s - The string representation of the property's value.

Returns:

The property's value.

getWidget

PropertyEditorWidget getWidget(Property property,
                               SwtWidget swtWidget,
                               SwtErrorStack errorStack)

Gets the property editor widget that will allow you to edit the properties for the specified property on the specified SWT widget (swtWidget). This returned widget will be used by the UI designer in its property editing area.

Parameters:

property - The property whose value will be edited.

swtWidget - The SWT widget whose property will be edited.

errorStack - The UI designer's SWT error stack.

Returns:

The property editor widget for the specified property and SWT widget.