java.lang.Object
- ro.sync.ecss.extensions.api.component.InternalComponentProvider
- - ro.sync.ecss.extensions.api.component.AbstractComponentProvider
  - - ro.sync.ecss.extensions.api.component.AuthorComponentProvider

All Implemented Interfaces:

ComponentProvider, EditorComponentProvider, DisplayModeConstants
```
@API(type=NOT_EXTENDABLE,
     src=PRIVATE)
public class AuthorComponentProvider
extends AbstractComponentProvider
```
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
- Fields inherited from class ro.sync.ecss.extensions.api.component.AbstractComponentProvider
  detectionFinished, logger, messages
- Fields inherited from interface ro.sync.exml.workspace.api.editor.page.author.DisplayModeConstants
  DISPLAY_MODE_BLOCK_TAGS, DISPLAY_MODE_BLOCK_TAGS_WITHOUT_TEXT, DISPLAY_MODE_FULL_TAGS, DISPLAY_MODE_FULL_TAGS_WITH_ATTRS, DISPLAY_MODE_INLINE_TAGS, DISPLAY_MODE_NO_TAGS, DISPLAY_MODE_PARTIAL_TAGS
- Fields inherited from interface ro.sync.ecss.extensions.api.component.EditorComponentProvider
  ATTRIBUTES_PANEL_ID, ELEMENTS_PANEL_ID, ENTITIES_PANEL_ID, MODEL_PANEL_ID, OUTLINER_PANEL_ID, REVIEWS_PANEL_ID

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`protected ro.sync.exml.editor.AbstractEditor`	`createEditor(ro.sync.exml.workspace.impl.component.BaseComponentEditorManager parentEditorManager, java.awt.Frame parentFrame, java.lang.String[] allowedPages, java.lang.String initialPage, java.lang.String contentType)`	Create an editor
`java.util.List<javax.swing.JToolBar>`	`createExtensionActionsToolbars()`	Deprecated. Please use instead the method ((WSAuthorComponentEditorPage)getWSEditorAccess().getCurrentPage()).createExtensionActionsToolbars();
`AuthorAccess`	`getAuthorAccess()`	Deprecated. Please use instead the method ((WSAuthorEditorPage)getWSEditorAccess().getCurrentPage()).getAuthorAccess().
`java.util.Map<java.lang.String,javax.swing.AbstractAction>`	`getAuthorCommonActions()`	Deprecated. Please use instead the method ((WSAuthorEditorPage)getWSEditorAccess().getCurrentPage()).getActionsProvider().getAuthorCommonActions().
`java.util.Map<java.lang.String,javax.swing.AbstractAction>`	`getAuthorExtensionActions()`	Deprecated. Please use instead the method ((WSAuthorEditorPage)getWSEditorAccess().getCurrentPage()).getActionsProvider().getAuthorExtensionActions().
`void`	`setBreadCrumbPopUpCustomizer(PopupMenuCustomizer popUpCustomizer)`	Deprecated. Please use instead the method ((WSAuthorComponentEditorPage)getWSEditorAccess().getCurrentPage()).setBreadCrumbPopUpCustomizer();
`void`	`setEditorPopUpCustomizer(PopupMenuCustomizer popUpCustomizer)`	Deprecated. Please use instead the method ((WSAuthorEditorPage)getWSEditorAccess().getCurrentPage())addPopUpMenuCustomizer(AuthorPopupMenuCustomizer popUpCustomizer)
`void`	`setOutlinerPopUpCustomizer(PopupMenuCustomizer popUpCustomizer)`	Deprecated. Please use instead the method ((WSAuthorComponentEditorPage)getWSEditorAccess().getCurrentPage()).setOutlinerPopUpCustomizer();
`void`	`showBreadCrumb(boolean showBreadCrumb)`	Deprecated. Please use instead the method ((WSAuthorComponentEditorPage)getWSEditorAccess().getCurrentPage()).showBreadCrumbPanel();

Methods inherited from class ro.sync.ecss.extensions.api.component.AbstractComponentProvider
addAuthorComponentListener, createReader, getAdditionalEditHelper, getEditorComponent, getEditorKey, getStatusComponent, getWSEditorAccess, isModified, load, print, removeAuthorComponentListener, save, setModified, showLocation, showLocation

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - createEditor
```
protected ro.sync.exml.editor.AbstractEditor createEditor(ro.sync.exml.workspace.impl.component.BaseComponentEditorManager parentEditorManager,
                                                          java.awt.Frame parentFrame,
                                                          java.lang.String[] allowedPages,
                                                          java.lang.String initialPage,
                                                          java.lang.String contentType)
                                                   throws AuthorComponentException
```
    Description copied from class: AbstractComponentProvider
    
    Create an editor
    
    Specified by:
    
    createEditor in class AbstractComponentProvider
    
    Parameters:
    
    parentEditorManager - The view manager.
    
    parentFrame - View's parent frame.
    
    allowedPages - The enumeration of allowed pages.
    
    initialPage - The initial page. Can be null
    
    contentType - The content type of the editor.
    
    Returns:
    
    The new created editor.
    
    Throws:
    
    AuthorComponentException
    
    See Also:
    
    AbstractComponentProvider.createEditor(ro.sync.exml.workspace.impl.component.BaseComponentEditorManager, java.awt.Frame, java.lang.String[], java.lang.String, java.lang.String)
  - setEditorPopUpCustomizer
```
@Deprecated
public void setEditorPopUpCustomizer(PopupMenuCustomizer popUpCustomizer)
```
    Deprecated.
    Please use instead the method ((WSAuthorEditorPage)getWSEditorAccess().getCurrentPage())addPopUpMenuCustomizer(AuthorPopupMenuCustomizer 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. If everything is removed then the menu will not be shown.
    
    Parameters:
    
    popUpCustomizer - The pop Up Customizer.
  - setOutlinerPopUpCustomizer
```
@Deprecated
public void setOutlinerPopUpCustomizer(PopupMenuCustomizer popUpCustomizer)
```
    Deprecated.
    Please use instead the method ((WSAuthorComponentEditorPage)getWSEditorAccess().getCurrentPage()).setOutlinerPopUpCustomizer();
    
    The Pop-up customizer can be used to add/remove actions from the pop-up menu in the Author Outliner view before showing it. If everything is removed then the menu will not be shown.
    
    Parameters:
    
    popUpCustomizer - The pop Up Customizer.
  - showBreadCrumb
```
@Deprecated
public void showBreadCrumb(boolean showBreadCrumb)
```
    Deprecated.
    Please use instead the method ((WSAuthorComponentEditorPage)getWSEditorAccess().getCurrentPage()).showBreadCrumbPanel();
    
    Show or hide the Bread Crumb panel in Author component.
    
    Parameters:
    
    showBreadCrumb - true to show the Bread Crumb.
    
    Since:
    
    14.1
  - setBreadCrumbPopUpCustomizer
```
@Deprecated
public void setBreadCrumbPopUpCustomizer(PopupMenuCustomizer popUpCustomizer)
```
    Deprecated.
    Please use instead the method ((WSAuthorComponentEditorPage)getWSEditorAccess().getCurrentPage()).setBreadCrumbPopUpCustomizer();
    
    The Pop-up customizer can be used to add/remove actions from the pop-up menu in the Author bread crumb before showing it. If everything is removed then the menu will not be shown.
    
    Parameters:
    
    popUpCustomizer - The pop Up Customizer.
  - createExtensionActionsToolbars
```
@Deprecated
public java.util.List<javax.swing.JToolBar> createExtensionActionsToolbars()
```
    Deprecated.
    Please use instead the method ((WSAuthorComponentEditorPage)getWSEditorAccess().getCurrentPage()).createExtensionActionsToolbars();
    
    Create toolbars with all the actions defined at the framework level in exactly the same order in which they have been added to the toolbars from the Document Type Edit dialog. The toolbars will look almost identical with the ones which appear when the XML is opened in an Oxygen standalone version.
    
    Returns:
    
    toolbars with all the actions defined at the framework level.
    
    Since:
    
    14.1
  - getAuthorExtensionActions
```
@Deprecated
public java.util.Map<java.lang.String,javax.swing.AbstractAction> getAuthorExtensionActions()
```
    Deprecated.
    Please use instead the method ((WSAuthorEditorPage)getWSEditorAccess().getCurrentPage()).getActionsProvider().getAuthorExtensionActions().
    
    Gets the map of author extension actions.
    This should get called after each load as the extension actions depend on the loaded document type.
    
    Returns:
    
    The map with (action id, AbstractAction) pairs with the actions defined in the Author framework. Can be null if no actions available.
  - getAuthorCommonActions
```
@Deprecated
public java.util.Map<java.lang.String,javax.swing.AbstractAction> getAuthorCommonActions()
```
    Deprecated.
    Please use instead the method ((WSAuthorEditorPage)getWSEditorAccess().getCurrentPage()).getActionsProvider().getAuthorCommonActions().
    
    Get the map of author common actions (undo, redo, cut, copy, paste, etc).
    
    Returns:
    
    The map with (action id, AbstractAction) pairs with the actions defined for working in the Author.
  - getAuthorAccess
```
@Deprecated
public AuthorAccess getAuthorAccess()
```
    Deprecated.
    Please use instead the method ((WSAuthorEditorPage)getWSEditorAccess().getCurrentPage()).getAuthorAccess().
    
    Get the author access used to perform various operations on the Author Page.
    
    Returns:
    
    The author access.

Class AuthorComponentProvider

Field Summary

Fields inherited from class ro.sync.ecss.extensions.api.component.AbstractComponentProvider

Fields inherited from interface ro.sync.exml.workspace.api.editor.page.author.DisplayModeConstants

Fields inherited from interface ro.sync.ecss.extensions.api.component.EditorComponentProvider

Method Summary

Methods inherited from class ro.sync.ecss.extensions.api.component.AbstractComponentProvider

Methods inherited from class java.lang.Object

Method Detail

createEditor

setEditorPopUpCustomizer

setOutlinerPopUpCustomizer

showBreadCrumb

setBreadCrumbPopUpCustomizer

createExtensionActionsToolbars

getAuthorExtensionActions

getAuthorCommonActions

getAuthorAccess