Oxygen XML Editor 15.0 Author API

ro.sync.ecss.extensions.api.editor
Class AbstractInplaceEditorWrapper

java.lang.Object
  extended by ro.sync.ecss.extensions.api.editor.AbstractInplaceEditorWrapper
All Implemented Interfaces:
ro.sync.ecss.extensions.api.editor.InplaceEditor, ro.sync.ecss.extensions.api.Extension

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

It can be used when more than one editor types are needed depending on the received context and it can choose at runtime an appropriate editor implementation. For example if in the CSS oxy_editor() function we have a test parameter with more possible values and we must provide a different editor implementation for each one.

Since:
14.1

Constructor Summary
AbstractInplaceEditorWrapper()
           
 
Method Summary
 void addEditingListener(InplaceEditingListener editingListener)
           
 void cancelEditing()
           
protected abstract  ro.sync.ecss.extensions.api.editor.InplaceEditor createEditor(AuthorInplaceContext context)
          Depending of the received context, create an editor.
 java.lang.String getDescription()
           
 java.lang.Object getEditorComponent(AuthorInplaceContext context, ro.sync.exml.view.graphics.Rectangle allocation, ro.sync.exml.view.graphics.Point mouseInvocationLocation)
           
 ro.sync.exml.view.graphics.Rectangle getScrollRectangle()
           
 java.lang.Object getValue()
           
 void removeEditingListener(InplaceEditingListener editingListener)
           
 void requestFocus()
           
 void stopEditing()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractInplaceEditorWrapper

public AbstractInplaceEditorWrapper()
Method Detail

getDescription

public java.lang.String getDescription()
Specified by:
getDescription in interface ro.sync.ecss.extensions.api.Extension
See Also:
Extension.getDescription()

createEditor

protected abstract ro.sync.ecss.extensions.api.editor.InplaceEditor createEditor(AuthorInplaceContext context)
Depending of the received context, create an editor.

Parameters:
context - Editing context.
Returns:
An in-place editor.

getEditorComponent

public final java.lang.Object getEditorComponent(AuthorInplaceContext context,
                                                 ro.sync.exml.view.graphics.Rectangle allocation,
                                                 ro.sync.exml.view.graphics.Point mouseInvocationLocation)
Specified by:
getEditorComponent in interface ro.sync.ecss.extensions.api.editor.InplaceEditor
See Also:
InplaceEditor.getEditorComponent(ro.sync.ecss.extensions.api.editor.AuthorInplaceContext, ro.sync.exml.view.graphics.Rectangle, ro.sync.exml.view.graphics.Point)

getScrollRectangle

public final ro.sync.exml.view.graphics.Rectangle getScrollRectangle()
Specified by:
getScrollRectangle in interface ro.sync.ecss.extensions.api.editor.InplaceEditor
See Also:
InplaceEditor.getScrollRectangle()

addEditingListener

public final void addEditingListener(InplaceEditingListener editingListener)
Specified by:
addEditingListener in interface ro.sync.ecss.extensions.api.editor.InplaceEditor
See Also:
InplaceEditor.addEditingListener(ro.sync.ecss.extensions.api.editor.InplaceEditingListener)

requestFocus

public final void requestFocus()
Specified by:
requestFocus in interface ro.sync.ecss.extensions.api.editor.InplaceEditor
See Also:
InplaceEditor.requestFocus()

getValue

public final java.lang.Object getValue()
Specified by:
getValue in interface ro.sync.ecss.extensions.api.editor.InplaceEditor
See Also:
InplaceEditor.getValue()

stopEditing

public final void stopEditing()
Specified by:
stopEditing in interface ro.sync.ecss.extensions.api.editor.InplaceEditor
See Also:
InplaceEditor.stopEditing()

cancelEditing

public final void cancelEditing()
Specified by:
cancelEditing in interface ro.sync.ecss.extensions.api.editor.InplaceEditor
See Also:
InplaceEditor.cancelEditing()

removeEditingListener

public final void removeEditingListener(InplaceEditingListener editingListener)
Specified by:
removeEditingListener in interface ro.sync.ecss.extensions.api.editor.InplaceEditor
See Also:
InplaceEditor.removeEditingListener(ro.sync.ecss.extensions.api.editor.InplaceEditingListener)

Oxygen XML Editor 15.0 Author API

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