Package com._1c.g5.v8.dt.ui.editor

Interface IProjectEditorSection

  • public interface IProjectEditorSection
    An Editor page section for the Configuration project editor. Describes the Configuration project editor page section content.

    A project editor section is defined in plugin.xml and are contributed to defined project editor pages. Following is an example definition of an 1C:Enterprise Runtime component executor extension: 

     <extension point="com._1c.g5.v8.dt.ui.projectEditorContributions">
   <section
     class="com._1c.g5.v8.dt.ui.editor.ExampleSection"
     description="This is example section for the project editor."
     id="com._1c.g5.v8.dt.ui.projectEditor.section.Example"
     page="com._1c.g5.v8.dt.ui.projectEditor.page.ExamplePage"
     title="Example">
   </section>
 </extension>

    This interface is intended to be implemented and registered by clients.

    Instances are not intended to be explicitly used by client.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void createContent​(IProjectEditor editor, org.eclipse.ui.forms.editor.IFormPage page, org.eclipse.ui.forms.widgets.FormToolkit toolkit, org.eclipse.swt.widgets.Composite parent, org.eclipse.ui.forms.widgets.Section section)
      Creates the UI content for this project page section.
      void dispose()
      Disposes this project page section.
      void doSave​(org.eclipse.core.runtime.IProgressMonitor monitor)
      Saves the contents of this page section.
      void inputChanged​(IProjectEditor editor)
      Notifies the page section that input for the project editor was changed (any project-related properties).
      boolean isDirty()
      Returns whether the contents of this page section have changed since the last save operation.
      org.eclipse.core.runtime.IStatus validate()
      Validates the section and returns the result as IStatus.

    • Method Detail

      • createContent

        void createContent​(IProjectEditor editor,
                   org.eclipse.ui.forms.editor.IFormPage page,
                   org.eclipse.ui.forms.widgets.FormToolkit toolkit,
                   org.eclipse.swt.widgets.Composite parent,
                   org.eclipse.ui.forms.widgets.Section section)
        Creates the UI content for this project page section.

        Clients should not call this method by themselves.

        Parameters:
        editor - the parent editor, cannot be null
        page - the parent editor page, cannot be null
        toolkit - the form toolkit to construct UI, cannot be null
        parent - the parent composite to create UI on, cannot be null
        section - the parent form section, cannot be null

      • inputChanged

        void inputChanged​(IProjectEditor editor)
        Notifies the page section that input for the project editor was changed (any project-related properties).
        Parameters:
        editor - the parent editor, cannot be null

      • isDirty

        boolean isDirty()
        Returns whether the contents of this page section have changed since the last save operation.

        If this value changes, the page section is intended to refresh parent project editor dirty state.

        Returns:
        whether the contents of this page section is in dirty state

      • doSave

        void doSave​(org.eclipse.core.runtime.IProgressMonitor monitor)
     throws org.eclipse.core.runtime.CoreException
        Saves the contents of this page section.

        If the save is cancelled through user action, or for any other reason, the page section should invoke setCancelled on the IProgressMonitor to inform the caller.

        This method can be long-running; progress and cancellation are provided by the given progress monitor.

        Parameters:
        monitor - the progress monitor to report progress to, cannot be null
        Throws:
        org.eclipse.core.runtime.CoreException - in case of save operation failure within the workspace

      • dispose

        void dispose()
        Disposes this project page section.

        Within this method a page section may release any resources, held by this page section. It is also very important to unregister all listeners from the page section.

        Clients should not call this method (the project editor calls this method at appropriate time).

      • validate

        org.eclipse.core.runtime.IStatus validate()
        Validates the section and returns the result as IStatus.
        Returns:
        Validation status, never null