Oxygen XML Editor 15.0 Author API

ro.sync.ecss.extensions.api
Class CustomAttributeValueEditor

java.lang.Object
  extended by ro.sync.ecss.extensions.api.CustomAttributeValueEditor
All Implemented Interfaces:
ro.sync.ecss.extensions.api.Extension

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

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

Since:
15

*********************************
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.


Constructor Summary
CustomAttributeValueEditor()
           
 
Method Summary
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)
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.

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.

Oxygen XML Editor 15.0 Author API

© Copyright SyncRO Soft SRL 2002 - 2013. All rights reserved.