|
Oxygen XML Editor 11.2 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object ro.sync.ecss.extensions.api.component.AuthorComponentProvider
public class AuthorComponentProvider
A component encapsulating all the visual editing part.
Developers can set the XML and CSS files, and access the document through the
AuthorAccess
API.
Field Summary | |
---|---|
static int |
ATTRIBUTES_PANEL_ID
Attributes Panel |
protected boolean |
detectionFinished
True if the detection finished |
static int |
ELEMENTS_PANEL_ID
Elements Panel |
static int |
ENTITIES_PANEL_ID
Entities Panel |
protected static ro.sync.exml.MessageBundle |
messages
The messages resource bundle. |
static int |
MODEL_PANEL_ID
Model Panel |
static int |
OUTLINER_PANEL_ID
Outliner Panel |
Fields inherited from interface ro.sync.ecss.layout.DisplayModeConstants |
---|
DISPLAY_MODE_BLOCK_TAGS, DISPLAY_MODE_FULL_TAGS, DISPLAY_MODE_FULL_TAGS_WITH_ATTRS, DISPLAY_MODE_INLINE_TAGS, DISPLAY_MODE_NO_TAGS, DISPLAY_MODE_PARTIAL_TAGS |
Method Summary | |
---|---|
void |
addAuthorComponentListener(AuthorComponentListener listener)
Add an author component listener |
Reader |
createReader()
Create a reader over the editor's current page content |
JComponent |
getAdditionalEditHelper(int helperID)
Get an additional edit helper panel. |
AuthorAccess |
getAuthorAccess()
Get the author access used to perform various operations on the Author Page. |
Map<String,AbstractAction> |
getAuthorCommonActions()
Get the map of author common actions (undo, redo, cut, copy, paste, etc) |
Map<String,AbstractAction> |
getAuthorExtensionActions()
Get the map of author extension actions. |
Component |
getEditorComponent()
|
Component |
getStatusComponent()
|
boolean |
isModified()
|
void |
load(URL url,
Reader reader)
Set the content to edit. |
void |
removeAuthorComponentListener(AuthorComponentListener listener)
Remove an author component listener |
void |
setBreadCrumbPopUpCustomizer(PopupMenuCustomizer popUpCustomizer)
The Pop-up customizer can be used to add/remove actions from the pop-up menu in the Author bread crumb before showing it. |
void |
setEditorPopUpCustomizer(PopupMenuCustomizer popUpCustomizer)
The Pop-up customizer can be used to add/remove actions from the pop-up menu in the Author page editor before showing it. |
void |
setOutlinerPopUpCustomizer(PopupMenuCustomizer popUpCustomizer)
The Pop-up customizer can be used to add/remove actions from the pop-up menu in the Author Outliner view before showing it. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected boolean detectionFinished
protected static ro.sync.exml.MessageBundle messages
public static final int OUTLINER_PANEL_ID
public static final int ATTRIBUTES_PANEL_ID
public static final int MODEL_PANEL_ID
public static final int ELEMENTS_PANEL_ID
public static final int ENTITIES_PANEL_ID
Method Detail |
---|
public void load(URL url, Reader reader) throws AuthorComponentException
url
- URL to load, can be null if the reader is specified
If no XML content reader is given, the URL will be used both to obtain the content and to solve relative references (eg: images).
If the XML content reader is also given, the URL will only be used to solve relative references from the file.reader
- The reader.
AuthorComponentException
- When there was a load problem (eg: IOException).public Reader createReader()
public void addAuthorComponentListener(AuthorComponentListener listener)
listener
- The listener.public void removeAuthorComponentListener(AuthorComponentListener listener)
listener
- The listener.public Component getEditorComponent()
public Component getStatusComponent()
public Map<String,AbstractAction> getAuthorExtensionActions()
public Map<String,AbstractAction> getAuthorCommonActions()
public boolean isModified()
public AuthorAccess getAuthorAccess()
public void setEditorPopUpCustomizer(PopupMenuCustomizer popUpCustomizer)
popUpCustomizer
- The pop Up Customizer.public void setOutlinerPopUpCustomizer(PopupMenuCustomizer popUpCustomizer)
popUpCustomizer
- The pop Up Customizer.public void setBreadCrumbPopUpCustomizer(PopupMenuCustomizer popUpCustomizer)
popUpCustomizer
- The pop Up Customizer.public JComponent getAdditionalEditHelper(int helperID)
helperID
- One of the AuthorComponentProvider.ATTRIBUTES_PANEL_ID, AuthorComponentProvider.ELEMENTS_PANEL_ID,
AuthorComponentProvider.ENTITIES_PANEL_ID, AuthorComponentProvider.MODEL_PANEL_ID, AuthorComponentProvider.OUTLINER_PANEL_ID constants.
|
Oxygen XML Editor 11.2 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |