Class CDOEditorUtil


  • public final class CDOEditorUtil
    extends java.lang.Object
    Some utility methods to cope with CDOEditor and CDOEditorInput
    Since:
    2.0
    Author:
    Victor Roldan Betancort
    • Field Detail

      • TEXT_EDITOR_ID

        public static final java.lang.String TEXT_EDITOR_ID
        Since:
        4.4
        See Also:
        Constant Field Values
    • Method Detail

      • getEditorID

        public static java.lang.String getEditorID()
        Since:
        4.1
      • setEditorID

        public static void setEditorID​(java.lang.String editorID)
        Since:
        4.1
      • createCDOEditorInput

        public static CDOEditorInput createCDOEditorInput​(CDOView view,
                                                          java.lang.String resourcePath,
                                                          boolean viewOwned)
        Returns an implementation of the CDOEditorInput interface.
      • createCDOEditorInputWithEditingDomain

        public static CDOEditorInput createCDOEditorInputWithEditingDomain​(CDOEditorInput input,
                                                                           EditingDomain editingDomain)
        Creates a CDOEditorInput based on the given input that adapts to the IEditingDomainProvider interface to provide a particular editingDomain.
        Parameters:
        input - an editor input to copy
        editingDomain - the editing domain to associate with the editor input
        Returns:
        the editing-domain-providing editor input
        Since:
        4.3
      • createCDOEditorInputWithEditingDomain

        public static CDOEditorInput createCDOEditorInputWithEditingDomain​(CDOView view,
                                                                           java.lang.String resourcePath,
                                                                           boolean viewOwned,
                                                                           EditingDomain editingDomain)
        Creates a CDOEditorInput that adapts to the IEditingDomainProvider interface to provide a particular editingDomain.
        Parameters:
        view - the CDO view of the editor input
        resourcePath - the path to the resource to edit
        viewOwned - whether the opened editor should assume ownership of the view
        editingDomain - the editing domain to associate with the editor input
        Returns:
        the editing-domain-providing editor input
        Since:
        4.3
      • openEditor

        public static void openEditor​(IWorkbenchPage page,
                                      CDOView view,
                                      java.lang.String resourcePath)
        Opens the specified resource in CDOEditor
        Parameters:
        page - The page in which the editor will be opened
        view - the CDOView that will be used to access the resource
        resourcePath - absolute path to the resource in the repository
      • findEditor

        public static IEditorReference[] findEditor​(IWorkbenchPage page,
                                                    CDOView view,
                                                    java.lang.String resourcePath,
                                                    CDOID objectID)
        Returns references to open instances of CDOEditor with given CDOView, resource path, and object ID.
        Parameters:
        page - The page on which to search for open editors.
        view - The CDOView that the editors are filtered for, or null if view filtering is not applicable.
        resourcePath - The resource path that the editors are filtered for, or null if resource path filtering is not applicable.
        objectID - The object ID that the editors are filtered for, or null if object ID filtering is not applicable.
        Since:
        4.8
      • findEditor

        public static IEditorReference[] findEditor​(IWorkbenchPage page,
                                                    CDOView view,
                                                    java.lang.String resourcePath)
        Returns references to open instances of CDOEditor with given CDOView, resource path, and object ID.
        Parameters:
        page - The page on which to search for open editors.
        view - The CDOView that the editors are filtered for, or null if view filtering is not applicable.
        resourcePath - The resource path that the editors are filtered for, or null if resource path filtering is not applicable.
      • getEffectiveEditorID

        public static java.lang.String getEffectiveEditorID​(CDOResourceLeaf resource)
        Since:
        4.2
      • getAllEditorIDs

        public static java.lang.String[] getAllEditorIDs​(CDOResourceLeaf resource)
        Since:
        4.2
      • createEditorInput

        public static IEditorInput createEditorInput​(java.lang.String editorID,
                                                     CDOResourceLeaf resource,
                                                     boolean viewOwned,
                                                     boolean lobCommitOnSave)
        Since:
        4.4
      • createLobEditorInput

        public static IEditorInput createLobEditorInput​(CDOResourceLeaf resource,
                                                        boolean lobCommitOnSave)
        Since:
        4.9
      • createEditorInput

        public static IEditorInput createEditorInput​(java.lang.String editorID,
                                                     CDOResourceLeaf resource,
                                                     boolean viewOwned)
        Returns an implementation of the IEditorInput interface.
        Since:
        4.2
      • createEditorInput

        public static IEditorInput createEditorInput​(java.lang.String editorID,
                                                     CDOResourceLeaf resource)
        Returns an implementation of the IEditorInput interface.
        Since:
        4.2
      • openEditor

        public static void openEditor​(IWorkbenchPage page,
                                      CDOResourceLeaf resource)
        Opens the specified resource in CDOEditor
        Parameters:
        page - The page in which the editor will be opened
        Since:
        4.2
      • openEditor

        public static void openEditor​(IWorkbenchPage page,
                                      java.lang.String editorID,
                                      CDOResourceLeaf resource)
        Opens the specified resource in CDOEditor
        Parameters:
        page - The page in which the editor will be opened
        Since:
        4.2
      • refreshEditors

        public static void refreshEditors​(IWorkbenchPage page,
                                          CDOView view)
        Refreshes all editor's viewers that are using certain CDOView.
        Parameters:
        page - the IWorkbenchPage where CDOEditor is opened
        view - instance of CDOView our editors are using