ro.sync.ecss.extensions.api.editor
Interface InplaceEditorCSSConstants

All Known Subinterfaces:

InplaceEditorArgumentKeys

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface InplaceEditorCSSConstants

Arguments of the oxy_editor function as well as built-in values for some of these arguments.

Since:

14.1

*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.

Field Summary

static java.lang.String	COMMA The variable used to add a comma in property values.
static java.lang.String	EDIT_CUSTOM Value of the PROPERTY_EDIT that indicates that the editor is doing a custom edit session and it's up to the editor to update the document.
static java.lang.String	EDIT_TEXT_CONTENT Value of the PROPERTY_EDIT that indicates that the text content of the element must be edited.
static java.lang.String	FALSE Possible value for PROPERTY_EDITABLE that marks the combo as NOT being editable.
static java.lang.String	INHERIT Value constant used for the color property.
static java.lang.String	PROPERTY_ACTION_ID Only applies to the TYPE_BUTTON and represents the ID of the action that must be invoked when the button is pressed.
static java.lang.String	PROPERTY_CLASSPATH If the form control is a custom implementation this property can be used to specify the class path where the custom implementation will loaded from.
static java.lang.String	PROPERTY_COLOR Property used to specify the foreground color.
static java.lang.String	PROPERTY_COLUMNS The number of columns that the editor should have.
static java.lang.String	PROPERTY_EDIT Indicates if we should edit an attribute value or the text value of the element.
static java.lang.String	PROPERTY_EDITABLE Only applies when the editor is a combo box and marks the combo as being editable or not.
static java.lang.String	PROPERTY_FONT_INHERIT Property used to specify that the font is inherited from the parent element.
static java.lang.String	PROPERTY_FORMAT It applies only on date picker form control.
static java.lang.String	PROPERTY_LABELS A set of labels to be associated with PROPERTY_VALUES.
static java.lang.String	PROPERTY_RENDERER_CLASS_NAME Class name of the renderer.
static java.lang.String	PROPERTY_RENDERER_SEPARATOR Used only when PROPERTY_TYPE is set to TYPE_POPUP_SELECTION.
static java.lang.String	PROPERTY_RENDERER_SORT Used only when PROPERTY_TYPE is set to TYPE_POPUP_SELECTION.
static java.lang.String	PROPERTY_ROWS The number of rows that the editor should have.
static java.lang.String	PROPERTY_SELECTION_MODE Used only when PROPERTY_TYPE is set to TYPE_POPUP_SELECTION.
static java.lang.String	PROPERTY_SEPARATOR Used only when PROPERTY_TYPE is set to TYPE_CHECKBOX or TYPE_POPUP_SELECTION.
static java.lang.String	PROPERTY_SWING_EDITOR_CLASS_NAME Class name of the editor.
static java.lang.String	PROPERTY_SWT_EDITOR_CLASS_NAME Class name of the editor.
static java.lang.String	PROPERTY_TOOLTIPS A set of tooltips to be associated with PROPERTY_VALUES.
static java.lang.String	PROPERTY_TRANSPARENT Only applies to the TYPE_BUTTON and ensures whether the button will have a more flat appearance (transparent).
static java.lang.String	PROPERTY_TYPE Indicates the editor that should be used to edit.
static java.lang.String	PROPERTY_UNCHECKED_VALUES Used only when PROPERTY_TYPE is set to TYPE_CHECKBOX.
static java.lang.String	PROPERTY_VALUES A set of values to be presented as choices.
static java.lang.String	SELECTION_MODE_MULTIPLE Possible value for "selectionMode".
static java.lang.String	SELECTION_MODE_SINGLE Possible value for "selectionMode".
static java.lang.String	SORT_ASCENDING Value Used only when PROPERTY_TYPE is set to TYPE_POPUP_SELECTION.
static java.lang.String	SORT_DESCENDING Value Used only when PROPERTY_TYPE is set to TYPE_POPUP_SELECTION.
static java.lang.String	TRUE Possible value for PROPERTY_EDITABLE that marks the combo as being editable.
static java.lang.String	TYPE_BUTTON Possible value for PROPERTY_TYPE.
static java.lang.String	TYPE_CHECKBOX Possible value for PROPERTY_TYPE.
static java.lang.String	TYPE_COMBOBOX Possible value for PROPERTY_TYPE.
static java.lang.String	TYPE_DATE_PICKER An editor that can be used to edit dates.
static java.lang.String	TYPE_OLD_URL_CHOOSER The old url chooser.
static java.lang.String	TYPE_POPUP_SELECTION The renderer presents a simple or compose value and the editor shows a pop-up like panel in which we can choose the values.
static java.lang.String	TYPE_TEXT Possible value for PROPERTY_TYPE.
static java.lang.String	TYPE_URL_CHOOSER Possible value for PROPERTY_TYPE.

Field Detail

PROPERTY_TYPE

static final java.lang.String PROPERTY_TYPE

Indicates the editor that should be used to edit. One of TYPE_ constants or a class name. This is a shorthand to specify a built-in type of renderer and editor as opposed to using properties PROPERTY_RENDERER_CLASS_NAME, PROPERTY_SWING_EDITOR_CLASS_NAME and PROPERTY_SWT_EDITOR_CLASS_NAME.

See Also:

Constant Field Values

PROPERTY_EDIT

static final java.lang.String PROPERTY_EDIT

Indicates if we should edit an attribute value or the text value of the element. The following values are accepted:

• To edit an attribute value the value of the property is "@attr_name".
• To edit the text content the value should be equal with EDIT_TEXT_CONTENT
• To let the editor do the editing itself, the value should be equal with EDIT_CUSTOM

See Also:

Constant Field Values

PROPERTY_VALUES

static final java.lang.String PROPERTY_VALUES

A set of values to be presented as choices. If not present these values will be taken from the schema. The processed value for this property is a list of CIValue.

See Also:

Constant Field Values

PROPERTY_UNCHECKED_VALUES

static final java.lang.String PROPERTY_UNCHECKED_VALUES

Used only when PROPERTY_TYPE is set to TYPE_CHECKBOX. These are the values that are committed for a checkbox when it is un-checked. If missing, an un-checked button will commit no value. The processed value for this property is a list of CIValue.

See Also:

Constant Field Values

PROPERTY_LABELS

static final java.lang.String PROPERTY_LABELS

A set of labels to be associated with PROPERTY_VALUES.

See Also:

Constant Field Values

PROPERTY_TOOLTIPS

static final java.lang.String PROPERTY_TOOLTIPS

A set of tooltips to be associated with PROPERTY_VALUES.

See Also:

Constant Field Values

PROPERTY_ROWS

static final java.lang.String PROPERTY_ROWS

The number of rows that the editor should have. It's interpretation is dependent to the editor being used.

See Also:

Constant Field Values

PROPERTY_COLUMNS

static final java.lang.String PROPERTY_COLUMNS

The number of columns that the editor should have. It's interpretation is dependent to the editor being used.

See Also:

Constant Field Values

PROPERTY_SEPARATOR

static final java.lang.String PROPERTY_SEPARATOR

Used only when PROPERTY_TYPE is set to TYPE_CHECKBOX or TYPE_POPUP_SELECTION. This is the separator that will be used to compose the values from the check-boxes into one string that will be committed into the document. If no separator is specified, a space will be used.

See Also:

Constant Field Values

PROPERTY_RENDERER_SEPARATOR

static final java.lang.String PROPERTY_RENDERER_SEPARATOR

Used only when PROPERTY_TYPE is set to TYPE_POPUP_SELECTION. This is the separator that will be used to compose the values from the check-boxes into one string that will be rendered in the document. If no separator is specified, PROPERTY_SEPARATOR will be used to identify tokens.

See Also:

Constant Field Values

PROPERTY_RENDERER_SORT

static final java.lang.String PROPERTY_RENDERER_SORT

Used only when PROPERTY_TYPE is set to TYPE_POPUP_SELECTION. This is the order in which the values in the element or attribute will appear rendered in the editor. If no sort order is specified, the values will be rendered in the order in which they appear in the document.

See Also:

Constant Field Values

SORT_ASCENDING

static final java.lang.String SORT_ASCENDING

Value Used only when PROPERTY_TYPE is set to TYPE_POPUP_SELECTION. Sort in ascending lexicographical order.

See Also:

Constant Field Values

SORT_DESCENDING

static final java.lang.String SORT_DESCENDING

Value Used only when PROPERTY_TYPE is set to TYPE_POPUP_SELECTION. Sort in descending lexicographical order.

See Also:

Constant Field Values

PROPERTY_EDITABLE

static final java.lang.String PROPERTY_EDITABLE

Only applies when the editor is a combo box and marks the combo as being editable or not. possible values are Boolean.TRUE and Boolean.FALSE.

See Also:

Constant Field Values

PROPERTY_ACTION_ID

static final java.lang.String PROPERTY_ACTION_ID

Only applies to the TYPE_BUTTON and represents the ID of the action that must be invoked when the button is pressed. It's processed value is an IAuthorExtensionAction. If an action with the given ID wasn't found the value remains the given string ID.

See Also:

Constant Field Values

PROPERTY_TRANSPARENT

static final java.lang.String PROPERTY_TRANSPARENT

Only applies to the TYPE_BUTTON and ensures whether the button will have a more flat appearance (transparent). The accepted values are true and false. The default value is false which will determine a classic looking button. When true, the SWING button will have no borders while the SWT one will be a tool item. The processed values will be either Boolean.TRUE or Boolean.FALSE.

See Also:

Constant Field Values

PROPERTY_RENDERER_CLASS_NAME

static final java.lang.String PROPERTY_RENDERER_CLASS_NAME

Class name of the renderer. This must be a SWING implementation for both the Oxygen stand alone or Eclipse plugin version. This class will be look for in the class path of the associated document type or in the PROPERTY_CLASSPATH.

See Also:

Constant Field Values

PROPERTY_SWING_EDITOR_CLASS_NAME

static final java.lang.String PROPERTY_SWING_EDITOR_CLASS_NAME

Class name of the editor. The SWING implementation is used for the Oxygen stand alone. This class will be look for in the class path of the associated document type or in the PROPERTY_CLASSPATH.

See Also:

Constant Field Values

PROPERTY_SWT_EDITOR_CLASS_NAME

static final java.lang.String PROPERTY_SWT_EDITOR_CLASS_NAME

Class name of the editor. The SWT implementation is used for the Eclipse plugin version. This class will be look for in the class path of the associated document type or in the PROPERTY_CLASSPATH.

See Also:

Constant Field Values

PROPERTY_CLASSPATH

static final java.lang.String PROPERTY_CLASSPATH

If the form control is a custom implementation this property can be used to specify the class path where the custom implementation will loaded from. A comma separated enumeration of URLs.

See Also:

Constant Field Values

PROPERTY_SELECTION_MODE

static final java.lang.String PROPERTY_SELECTION_MODE

Used only when PROPERTY_TYPE is set to TYPE_POPUP_SELECTION. It's possible values are SELECTION_MODE_SINGLE and SELECTION_MODE_MULTIPLE. The default value is SELECTION_MODE_MULTIPLE.

See Also:

Constant Field Values

PROPERTY_FONT_INHERIT

static final java.lang.String PROPERTY_FONT_INHERIT

Property used to specify that the font is inherited from the parent element. It's possible values are true or false.

See Also:

Constant Field Values

PROPERTY_COLOR

static final java.lang.String PROPERTY_COLOR

Property used to specify the foreground color. It's possible values are a color or 'inherit' if the color should be inherited from the element.

See Also:

Constant Field Values

TYPE_BUTTON

static final java.lang.String TYPE_BUTTON

Possible value for PROPERTY_TYPE. Indicates that a combo box should be used to render and edit.

See Also:

Constant Field Values

TYPE_COMBOBOX

static final java.lang.String TYPE_COMBOBOX

Possible value for PROPERTY_TYPE. Indicates that a combo box should be used to render and edit.

See Also:

Constant Field Values

TYPE_TEXT

static final java.lang.String TYPE_TEXT

Possible value for PROPERTY_TYPE. Indicates that a text field with content completion support should be used to render and edit.

See Also:

Constant Field Values

TYPE_CHECKBOX

static final java.lang.String TYPE_CHECKBOX

Possible value for PROPERTY_TYPE. Indicates that a check box panel should be used to render and edit.

See Also:

Constant Field Values

TYPE_POPUP_SELECTION

static final java.lang.String TYPE_POPUP_SELECTION

The renderer presents a simple or compose value and the editor shows a pop-up like panel in which we can choose the values.

See Also:

Constant Field Values

TYPE_URL_CHOOSER

static final java.lang.String TYPE_URL_CHOOSER

Possible value for PROPERTY_TYPE. Indicates that a URL chooser should be used to render and edit. The new type of URL chooser that uses an InputUrlPanel.

See Also:

Constant Field Values

EDIT_TEXT_CONTENT

static final java.lang.String EDIT_TEXT_CONTENT

Value of the PROPERTY_EDIT that indicates that the text content of the element must be edited.

See Also:

Constant Field Values

EDIT_CUSTOM

static final java.lang.String EDIT_CUSTOM

Value of the PROPERTY_EDIT that indicates that the editor is doing a custom edit session and it's up to the editor to update the document.

In this case the notification InplaceEditingListener.commitValue(EditingEvent) will do nothing since it's not clear where should the given value be committed.

The notification InplaceEditingListener.editingStopped(EditingEvent) will also stop the editing session without committing any value. It's up to the custom editor to make the necessary changes into the document (but only after the previous mentioned notification was issued).

Warning: All changes to the document (that the custom editor must do) must be performed after the InplaceEditingListener.editingStopped(EditingEvent) notification was fired. Because the editing is automatically stopped on any document modification an infinite loop will happen if the previous condition is not met.

See Also:

Constant Field Values

FALSE

static final java.lang.String FALSE

Possible value for PROPERTY_EDITABLE that marks the combo as NOT being editable.

See Also:

Constant Field Values

TRUE

static final java.lang.String TRUE

Possible value for PROPERTY_EDITABLE that marks the combo as being editable.

See Also:

Constant Field Values

SELECTION_MODE_SINGLE

static final java.lang.String SELECTION_MODE_SINGLE

Possible value for "selectionMode". Only a single value will be selected.

See Also:

Constant Field Values

SELECTION_MODE_MULTIPLE

static final java.lang.String SELECTION_MODE_MULTIPLE

Possible value for "selectionMode". It allows multiple values to be selected.

See Also:

Constant Field Values

TYPE_DATE_PICKER

static final java.lang.String TYPE_DATE_PICKER

An editor that can be used to edit dates. It handles schema types xs:date and xs:datetime or any type with a specified Java format from CSS.

See Also:

Constant Field Values

TYPE_OLD_URL_CHOOSER

static final java.lang.String TYPE_OLD_URL_CHOOSER

The old url chooser. Left here as a workaround if someone got really attached to it.

See Also:

Constant Field Values

PROPERTY_FORMAT

static final java.lang.String PROPERTY_FORMAT

It applies only on date picker form control. It specifies the date-time format of the edited value.

See Also:

Constant Field Values

COMMA

static final java.lang.String COMMA

The variable used to add a comma in property values. The real comma is used as a delimiter for multiple values thus this special variable is needed.

See Also:

Constant Field Values

INHERIT

static final java.lang.String INHERIT

Value constant used for the color property.

See Also:

Constant Field Values