@API(type=NOT_EXTENDABLE,
src=PUBLIC)
public class AuthorInplaceContext
extends java.lang.Object
Constructor and Description |
---|
AuthorInplaceContext(java.util.Map<java.lang.String,java.lang.Object> arguments,
AuthorElement elem,
Styles styles,
AuthorSchemaManager schemaManager,
AuthorAccess authorAccess,
java.lang.Object parentHost,
DynamicPropertyEvaluator propsEvaluator)
The editor context.
|
Modifier and Type | Method and Description |
---|---|
java.util.Map<java.lang.String,java.lang.Object> |
getArguments() |
java.lang.String |
getAttributeToEdit()
Deprecated.
Use
getAttributeToEditQName() instead.
This method returns the attribute name as it was specified in the CSS.
If a QName was specified then this QName might not be valid in the context
of the current element. Property InplaceEditorArgumentKeys.PROPERTY_EDIT_QUALIFIED
should be used in these situations. |
static java.lang.String |
getAttributeToEdit(java.lang.String toEdit)
Checks if the property
InplaceEditorCSSConstants.PROPERTY_EDIT specifies
an attribute to be edited. |
javax.xml.namespace.QName |
getAttributeToEditQName()
The QName of the edited attribute.
|
AuthorAccess |
getAuthorAccess() |
AuthorElement |
getElem()
Get the element being edited.
|
java.lang.String |
getErrorMessage() |
java.lang.Object |
getParentHost()
The parent host in which the editor will be added or the renderer will be
painted.
|
DynamicPropertyEvaluator |
getPropertyEvaluator()
Some form control properties can't be evaluated at
the time the CSS is compiled.
|
Point |
getRelativeMouseLocation()
If the mouse is currently hovering the area of this editor this represents
the X,Y location relative to the editor bounds.
|
AuthorSchemaManager |
getSchemaManager() |
Styles |
getStyles() |
boolean |
isReadOnlyContext()
Checks if the form control is added in a context where changes are not
permitted.
|
void |
setErrorMessage(java.lang.String errorMessage)
Sets an error message encountered while building the context.
|
void |
setReadOnlyContext(boolean readOnlyContext)
Sets if the form control is added in a context where editing is not permitted.
|
void |
setRelativeMousePosition(Point relativeMousePosition)
If the mouse is currently hovering the area of this editor this represents
the X,Y location relative to the editor bounds.
|
public AuthorInplaceContext(java.util.Map<java.lang.String,java.lang.Object> arguments, AuthorElement elem, Styles styles, AuthorSchemaManager schemaManager, AuthorAccess authorAccess, java.lang.Object parentHost, DynamicPropertyEvaluator propsEvaluator)
arguments
- The editor argumentselem
- The element being edited.styles
- The styles of the element where the editing takes placeschemaManager
- Provides support for obtaining information about what elements, attributes can be inserted
in a given context.authorAccess
- Provides access to different functions.parentHost
- The parent host in which the editor will be added or the renderer will be
painted. If we are in the stand-alone Oxygen version this will be a JPanel.
If we are in the Oxygen Eclipse plug-in this will be a Composite. For SWT,
an editor will require the parent in order to create itself.propsEvaluator
- Some form control properties can't be evaluated at
the time the CSS is compiled. This interface can be used by form controls to
expand such properties.public DynamicPropertyEvaluator getPropertyEvaluator()
public java.util.Map<java.lang.String,java.lang.Object> getArguments()
InplaceEditorArgumentKeys
.@Deprecated public java.lang.String getAttributeToEdit()
getAttributeToEditQName()
instead.
This method returns the attribute name as it was specified in the CSS.
If a QName was specified then this QName might not be valid in the context
of the current element. Property InplaceEditorArgumentKeys.PROPERTY_EDIT_QUALIFIED
should be used in these situations.null
no attribute was specified in which case the text should be edited.public javax.xml.namespace.QName getAttributeToEditQName()
null
if not editing an attribute.public static java.lang.String getAttributeToEdit(java.lang.String toEdit)
InplaceEditorCSSConstants.PROPERTY_EDIT
specifies
an attribute to be edited.toEdit
- The value of the property InplaceEditorCSSConstants.PROPERTY_EDIT
null
if no attribute name was specified.public AuthorElement getElem()
public AuthorSchemaManager getSchemaManager()
public AuthorAccess getAuthorAccess()
public java.lang.Object getParentHost()
public void setErrorMessage(java.lang.String errorMessage)
errorMessage
- An error message encountered while building the context.public java.lang.String getErrorMessage()
public Styles getStyles()
public void setRelativeMousePosition(Point relativeMousePosition)
null
if the mouse is not over the editor.
This information is relevant only when the editor is painted. When editing
is started the editor can just add mouse listeners onto itself.relativeMousePosition
- The mouse location if the mouse is over the editor.public Point getRelativeMouseLocation()
null
if the mouse is not over the editor.
This information is relevant only when the editor is painted. When editing
is started the editor can just add mouse listeners onto itself.public void setReadOnlyContext(boolean readOnlyContext)
readOnlyContext
- true
if this form control is added in
a context where changes are not permitted.public boolean isReadOnlyContext()
true
if this form control is added in a context where
changes are not permitted.© Copyright SyncRO Soft SRL 2002 - 2015. All rights reserved.