ro.sync.ecss.extensions.api

Class CustomAttributeValueEditor

java.lang.Object

ro.sync.ecss.extensions.api.CustomAttributeValueEditor

All Implemented Interfaces:

Extension

@API(type=EXTENDABLE,
     src=PUBLIC)
public abstract class CustomAttributeValueEditor
extends java.lang.Object
implements Extension

A custom editor which gets invoked to edit the value for an attribute.

Since:

15

Constructor Summary

Constructors

Constructor and Description
CustomAttributeValueEditor()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getAttributeValue(EditedAttribute attribute, java.lang.Object parentComponent) Get a value for the current attribute.
abstract boolean	shouldHandleAttribute(EditedAttribute attribute) Ask the custom editor if it wants to handle editing for a certain attribute.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ro.sync.ecss.extensions.api.Extension

getDescription

Constructor Detail

CustomAttributeValueEditor

public CustomAttributeValueEditor()

Method Detail

getAttributeValue

public abstract java.lang.String getAttributeValue(EditedAttribute attribute,
                                                   java.lang.Object parentComponent)
                                            throws CancelledByUserException

Get a value for the current attribute.

Parameters:

attribute - The attribute to be edited.

parentComponent - The parent component, usually the table in which the user double clicked the value. Used for example to find the parent window/shell when creating dialogs.

Returns:

The proposed value. Returning the empty string will commit it as a value, returning null will remove the attribute, while throwing a CancelledByUserException will cancel the editing.

Throws:

CancelledByUserException - When the user cancels the editing.

shouldHandleAttribute

public abstract boolean shouldHandleAttribute(EditedAttribute attribute)

Ask the custom editor if it wants to handle editing for a certain attribute.

Parameters:

attribute - The attribute.

Returns:

true if this custom editor's "getAttributeValue" method should be invoked for that certain attribute.