Class MdHelpContentEditor

  • All Implemented Interfaces:
    IEventListener, IDtHtmlEditorPart, org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.jface.dialogs.IPageChangeProvider, org.eclipse.ui.IEditorPart, org.eclipse.ui.ISaveablePart, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.IShowInSource, org.eclipse.ui.part.IWorkbenchPartOrientation

    public class MdHelpContentEditor
    extends HtmlMultiPageEditor
    implements IEventListener
    The Metadata objects help content editor
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String EDITOR_ID  
      • Fields inherited from class org.eclipse.ui.part.MultiPageEditorPart

        PAGE_CONTAINER_SITE
      • Fields inherited from interface org.eclipse.ui.IEditorPart

        PROP_DIRTY, PROP_INPUT
      • Fields inherited from interface org.eclipse.ui.IWorkbenchPart

        PROP_TITLE
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void createPages()  
      protected IPreviewHtmlPageContentProvider createPreviewHtmlPageContentProvider​(String previewUrl)
      Construct preview page content provider
      protected WysiwygHtmlPage createWysiwygHtmlPage​(org.eclipse.swt.widgets.Composite container)
      Construct wysiwyg page control
      void dispose()  
      void doSave​(org.eclipse.core.runtime.IProgressMonitor monitor)  
      protected MdHelpContentFileEditorInput getFileEditorInput()
      Get file based editor input for structured text editor
      protected String getReadOnlyText()
      Get html text for showing in read only editor mode
      org.eclipse.ui.part.ShowInContext getShowInContext()  
      void handleEvent​(IEvent event)
      Process event of specified type
      void init​(org.eclipse.ui.IEditorSite site, org.eclipse.ui.IEditorInput editorInput)  
      boolean isDirty()  
      protected boolean isReadOnly()
      The read mode in which the editor is opened.
      boolean isSaveAsAllowed()  
      protected void pageChange​(int newPageIndex)  
      void setFocus()  
      • Methods inherited from class org.eclipse.ui.part.MultiPageEditorPart

        activateSite, addPage, addPage, addPage, addPage, addPageChangedListener, createContainer, createItem, createPageContainer, createPartControl, createSite, deactivateSite, findEditors, getActiveEditor, getActivePage, getContainer, getControl, getEditor, getPageCount, getPageImage, getPageSite, getPageText, getSelectedPage, initializePageSwitching, removePage, removePageChangedListener, setActiveEditor, setActivePage, setControl, setPageImage, setPageText
      • Methods inherited from class org.eclipse.ui.part.EditorPart

        checkSite, getEditorInput, getEditorSite, getTitleToolTip, isSaveOnCloseNeeded, setContentDescription, setInitializationData, setInput, setInputWithNotify, setPartName
      • Methods inherited from class org.eclipse.ui.part.WorkbenchPart

        addPartPropertyListener, addPropertyListener, firePartPropertyChanged, firePropertyChange, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, removePartPropertyListener, removePropertyListener, setPartProperty, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy
      • Methods inherited from class org.eclipse.core.commands.common.EventManager

        addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
      • Methods inherited from interface org.eclipse.ui.IWorkbenchPart

        addPropertyListener, getSite, getTitle, getTitleImage, removePropertyListener
    • Constructor Detail

      • MdHelpContentEditor

        public MdHelpContentEditor()
    • Method Detail

      • init

        public void init​(org.eclipse.ui.IEditorSite site,
                         org.eclipse.ui.IEditorInput editorInput)
                  throws org.eclipse.ui.PartInitException
        Specified by:
        init in interface org.eclipse.ui.IEditorPart
        Overrides:
        init in class HtmlMultiPageEditor
        Throws:
        org.eclipse.ui.PartInitException
      • dispose

        public void dispose()
        Specified by:
        dispose in interface org.eclipse.ui.IWorkbenchPart
        Overrides:
        dispose in class HtmlMultiPageEditor
      • isDirty

        public boolean isDirty()
        Specified by:
        isDirty in interface org.eclipse.ui.ISaveablePart
        Overrides:
        isDirty in class org.eclipse.ui.part.MultiPageEditorPart
      • isReadOnly

        protected boolean isReadOnly()
        Description copied from class: HtmlMultiPageEditor
        The read mode in which the editor is opened.

        Subclasses can override this method to control editor read only mode

        Overrides:
        isReadOnly in class HtmlMultiPageEditor
        Returns:
        true to open editor in read only mode, or false in otherwise
      • doSave

        public void doSave​(org.eclipse.core.runtime.IProgressMonitor monitor)
        Specified by:
        doSave in interface org.eclipse.ui.ISaveablePart
        Overrides:
        doSave in class HtmlMultiPageEditor
      • isSaveAsAllowed

        public boolean isSaveAsAllowed()
        Specified by:
        isSaveAsAllowed in interface org.eclipse.ui.ISaveablePart
        Overrides:
        isSaveAsAllowed in class HtmlMultiPageEditor
      • handleEvent

        public void handleEvent​(IEvent event)
        Description copied from interface: IEventListener
        Process event of specified type
        Specified by:
        handleEvent in interface IEventListener
        Parameters:
        event - the event to handle (cannot be null)
      • getShowInContext

        public org.eclipse.ui.part.ShowInContext getShowInContext()
        Specified by:
        getShowInContext in interface org.eclipse.ui.part.IShowInSource
        Overrides:
        getShowInContext in class HtmlMultiPageEditor
      • setFocus

        public void setFocus()
        Specified by:
        setFocus in interface org.eclipse.ui.IWorkbenchPart
        Overrides:
        setFocus in class org.eclipse.ui.part.MultiPageEditorPart
      • createWysiwygHtmlPage

        protected WysiwygHtmlPage createWysiwygHtmlPage​(org.eclipse.swt.widgets.Composite container)
                                                 throws org.eclipse.ui.PartInitException
        Description copied from class: HtmlMultiPageEditor

        Construct wysiwyg page control

        Subclasses may extend.

        Overrides:
        createWysiwygHtmlPage in class HtmlMultiPageEditor
        Parameters:
        container - the composite control containing this multi-page editor pages, cannot be null
        Returns:
        instance of WysiwygHtmlPage, never null
        Throws:
        org.eclipse.ui.PartInitException - if page cannot be initialized