oracle.jdeveloper.webapp.metadata
Interface ContextualComponentEditor

public interface ContextualComponentEditor

The ContextualComponentEditor interface that provides a custom editor that is able to edit a UI Component and its content. An instance of this interface can be reused in different editing contexts. Before the instance is reused the releaseEditor() will be called on it.

See Also:

ComponentEditorContext

Method Summary

java.awt.Component	getComponentEditor() Returns the Swing component that is UI representation of the component editor.
boolean	handleModelChange(oracle.bali.xml.model.XmlModelEvent event) Gives a chance to the component editor to update its state when the underlyning model changes.
void	releaseEditor() Called by the component editor environment to tell the component editor to cleanup its state.
void	setContext(ComponentEditorContext context) Called by the component editor environment to provide additional information.

Method Detail

setContext

void setContext(ComponentEditorContext context)

Called by the component editor environment to provide additional information. This method is always called once before all other to set up the component editor

Parameters:

context - Contextual information.

releaseEditor

void releaseEditor()

Called by the component editor environment to tell the component editor to cleanup its state. This method is always called once at the end of the editor usage. Only call that may be called immidiatly after this one is setContext(ComponentEditorContext) in case the editor is about to be reused.

getComponentEditor

java.awt.Component getComponentEditor()

Returns the Swing component that is UI representation of the component editor.

Returns:

handleModelChange

boolean handleModelChange(oracle.bali.xml.model.XmlModelEvent event)

Gives a chance to the component editor to update its state when the underlyning model changes. Component editor should return true if it handled the model change completally, and the component editor environment does not need to process the event itself.

Parameters:

event -

Returns:

true if the component editor handled the model change completally