Package org.apache.uima.taeconfigurator.editors.ui

Class HeaderPage

java.lang.Object
org.eclipse.core.commands.common.EventManager
org.eclipse.ui.part.WorkbenchPart
org.eclipse.ui.part.EditorPart
org.eclipse.ui.forms.editor.FormPage
org.apache.uima.taeconfigurator.editors.ui.HeaderPage
All Implemented Interfaces:
org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.ui.forms.editor.IFormPage, org.eclipse.ui.IEditorPart, org.eclipse.ui.ISaveablePart, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.IWorkbenchPartOrientation
Direct Known Subclasses:
HeaderPageWithSash
public abstract class HeaderPage extends org.eclipse.ui.forms.editor.FormPage
Common part of most pages.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected MultiPageEditor
    editor
    The editor.
    static final boolean
    EQUAL_WIDTH
    The Constant EQUAL_WIDTH.
    protected org.eclipse.swt.widgets.Composite
    leftPanel
    The left panel.
    protected float
    leftPanelPercent
    The left panel percent.
    protected int
    leftPanelWidth
    The left panel width.
    protected org.eclipse.swt.widgets.Composite
    rightPanel
    The right panel.
    protected float
    rightPanelPercent
    The right panel percent.
    protected int
    rightPanelWidth
    The right panel width.
    protected org.eclipse.swt.custom.SashForm
    sashForm
    The sash form.
    protected int
    sashFormWidth
    The sash form width.
    protected org.eclipse.ui.forms.widgets.FormToolkit
    toolkit
    The toolkit.

    Fields inherited from interface org.eclipse.ui.IEditorPart

    PROP_DIRTY, PROP_INPUT

    Fields inherited from interface org.eclipse.ui.IWorkbenchPart

    PROP_TITLE

  • Constructor Summary

    Constructors
    Constructor
    Description
    HeaderPage(MultiPageEditor formEditor, String pageTitle)
    Instantiates a new header page.
    HeaderPage(MultiPageEditor formEditor, String id, String keyPageTitle)
    Instantiates a new header page.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected AnalysisEngineMetaData
    getAnalysisEngineMetaData()
    Gets the analysis engine meta data.
    protected boolean
    isAeDescriptor()
    Checks if is ae descriptor.
    boolean
    isCasConsumerDescriptor()
    Checks if is cas consumer descriptor.
    boolean
    isCasInitializerDescriptor()
    Checks if is cas initializer descriptor.
    boolean
    isCollectionReaderDescriptor()
    Checks if is collection reader descriptor.
    boolean
    isExtResAndBindingsDescriptor()
    Checks if is ext res and bindings descriptor.
    boolean
    isIndexDescriptor()
    Checks if is index descriptor.
    boolean
    isLocalProcessingDescriptor()
    Checks if is local processing descriptor.
    protected boolean
    isPrimitive()
    Checks if is primitive.
    boolean
    isTypePriorityDescriptor()
    Checks if is type priority descriptor.
    boolean
    isTypeSystemDescriptor()
    Checks if is type system descriptor.
    void
    markStale()
    Mark stale.
    protected void
    maybeInitialize(org.eclipse.ui.forms.IManagedForm managedForm)
    Maybe initialize.
    org.eclipse.swt.widgets.Composite
    newCentered2SpanComposite(org.eclipse.swt.widgets.Composite parent)
    New centered 2 span composite.
    org.eclipse.swt.widgets.Composite
    newComposite(org.eclipse.swt.widgets.Composite parent)
    New composite.
    org.eclipse.swt.widgets.Composite
    newnColumnSection(org.eclipse.swt.widgets.Composite parent, int cols)
    Newn column section.
    org.eclipse.swt.widgets.Composite
    setup1ColumnLayout(org.eclipse.ui.forms.IManagedForm managedForm)
    Setup 1 column layout.
    org.eclipse.swt.widgets.Composite
    setup2ColumnGrid(org.eclipse.ui.forms.IManagedForm managedForm, boolean equalWidth)
    Setup 2 column grid.
    Form2Panel
    setup2ColumnLayout(org.eclipse.ui.forms.IManagedForm managedForm, boolean equalWidth)
    Sash impl.
    Form2Panel
    setup2ColumnLayout(org.eclipse.ui.forms.IManagedForm managedForm, int w1, int w2)
    Setup 2 column layout.
    Form2Panel
    setup2ColumnLayoutNotSash(org.eclipse.ui.forms.IManagedForm managedForm, boolean equalWidth)
    Setup 2 column layout not sash.
    Form2Panel
    setup2ColumnLayoutOn4Grid(org.eclipse.ui.forms.IManagedForm managedForm, boolean equalWidth)
    Setup 2 column layout on 4 grid.
    protected void
    spacer(org.eclipse.swt.widgets.Composite container)
    Spacer.

    Methods inherited from class org.eclipse.ui.forms.editor.FormPage

    canLeaveThePage, createFormContent, createPartControl, dispose, doSave, doSaveAs, getEditor, getId, getIndex, getManagedForm, getPartControl, getTitleImage, init, initialize, isActive, isDirty, isEditor, isSaveAsAllowed, selectReveal, setActive, setFocus, setIndex

    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, getAdapter, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, 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 class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.eclipse.core.runtime.IAdaptable

    getAdapter

    Methods inherited from interface org.eclipse.ui.IEditorPart

    getEditorInput, getEditorSite

    Methods inherited from interface org.eclipse.ui.ISaveablePart

    isSaveOnCloseNeeded

    Methods inherited from interface org.eclipse.ui.IWorkbenchPart

    addPropertyListener, getSite, getTitle, getTitleToolTip, removePropertyListener

  • Field Details

    • EQUAL_WIDTH

      public static final boolean EQUAL_WIDTH
      The Constant EQUAL_WIDTH.
      See Also:

    • sashForm

      protected org.eclipse.swt.custom.SashForm sashForm
      The sash form.

    • editor

      protected MultiPageEditor editor
      The editor.

    • toolkit

      protected org.eclipse.ui.forms.widgets.FormToolkit toolkit
      The toolkit.

    • leftPanel

      protected org.eclipse.swt.widgets.Composite leftPanel
      The left panel.

    • rightPanel

      protected org.eclipse.swt.widgets.Composite rightPanel
      The right panel.

    • sashFormWidth

      protected int sashFormWidth
      The sash form width.

    • leftPanelPercent

      protected float leftPanelPercent
      The left panel percent.

    • rightPanelPercent

      protected float rightPanelPercent
      The right panel percent.

    • leftPanelWidth

      protected int leftPanelWidth
      The left panel width.

    • rightPanelWidth

      protected int rightPanelWidth
      The right panel width.

  • Constructor Details

    • HeaderPage

      public HeaderPage(MultiPageEditor formEditor, String id, String keyPageTitle)
      Instantiates a new header page.
      Parameters:
      formEditor - the form editor
      id - the id
      keyPageTitle - the key page title

    • HeaderPage

      public HeaderPage(MultiPageEditor formEditor, String pageTitle)
      Instantiates a new header page.
      Parameters:
      formEditor - the form editor
      pageTitle - the page title

  • Method Details

    • maybeInitialize

      protected void maybeInitialize(org.eclipse.ui.forms.IManagedForm managedForm)
      Maybe initialize.
      Parameters:
      managedForm - the managed form

    • newComposite

      public org.eclipse.swt.widgets.Composite newComposite(org.eclipse.swt.widgets.Composite parent)
      New composite.
      Parameters:
      parent - the parent
      Returns:
      the composite

    • newCentered2SpanComposite

      public org.eclipse.swt.widgets.Composite newCentered2SpanComposite(org.eclipse.swt.widgets.Composite parent)
      New centered 2 span composite.
      Parameters:
      parent - the parent
      Returns:
      the composite

    • newnColumnSection

      public org.eclipse.swt.widgets.Composite newnColumnSection(org.eclipse.swt.widgets.Composite parent, int cols)
      Newn column section.
      Parameters:
      parent - the parent
      cols - the cols
      Returns:
      the composite

    • setup1ColumnLayout

      public org.eclipse.swt.widgets.Composite setup1ColumnLayout(org.eclipse.ui.forms.IManagedForm managedForm)
      Setup 1 column layout.
      Parameters:
      managedForm - the managed form
      Returns:
      the composite

    • setup2ColumnGrid

      public org.eclipse.swt.widgets.Composite setup2ColumnGrid(org.eclipse.ui.forms.IManagedForm managedForm, boolean equalWidth)
      Setup 2 column grid.
      Parameters:
      managedForm - the managed form
      equalWidth - the equal width
      Returns:
      the composite

    • setup2ColumnLayout

      public Form2Panel setup2ColumnLayout(org.eclipse.ui.forms.IManagedForm managedForm, int w1, int w2)
      Setup 2 column layout.
      Parameters:
      managedForm - the managed form
      w1 - the w 1
      w2 - the w 2
      Returns:
      the form 2 panel

    • setup2ColumnLayout

      public Form2Panel setup2ColumnLayout(org.eclipse.ui.forms.IManagedForm managedForm, boolean equalWidth)
      Sash impl.
      Parameters:
      managedForm - the managed form
      equalWidth - the equal width
      Returns:
      the form 2 panel

    • setup2ColumnLayoutNotSash

      public Form2Panel setup2ColumnLayoutNotSash(org.eclipse.ui.forms.IManagedForm managedForm, boolean equalWidth)
      Setup 2 column layout not sash.
      Parameters:
      managedForm - the managed form
      equalWidth - the equal width
      Returns:
      the form 2 panel

    • setup2ColumnLayoutOn4Grid

      public Form2Panel setup2ColumnLayoutOn4Grid(org.eclipse.ui.forms.IManagedForm managedForm, boolean equalWidth)
      Setup 2 column layout on 4 grid.
      Parameters:
      managedForm - the managed form
      equalWidth - the equal width
      Returns:
      the form 2 panel

    • spacer

      protected void spacer(org.eclipse.swt.widgets.Composite container)
      Spacer.
      Parameters:
      container - the container

    • markStale

      public void markStale()
      Mark stale.

    • isPrimitive

      protected boolean isPrimitive()
      Checks if is primitive.
      Returns:
      true, if is primitive

    • isAeDescriptor

      protected boolean isAeDescriptor()
      Checks if is ae descriptor.
      Returns:
      true, if is ae descriptor

    • isTypeSystemDescriptor

      public boolean isTypeSystemDescriptor()
      Checks if is type system descriptor.
      Returns:
      true, if is type system descriptor

    • isIndexDescriptor

      public boolean isIndexDescriptor()
      Checks if is index descriptor.
      Returns:
      true, if is index descriptor

    • isTypePriorityDescriptor

      public boolean isTypePriorityDescriptor()
      Checks if is type priority descriptor.
      Returns:
      true, if is type priority descriptor

    • isExtResAndBindingsDescriptor

      public boolean isExtResAndBindingsDescriptor()
      Checks if is ext res and bindings descriptor.
      Returns:
      true, if is ext res and bindings descriptor

    • isCollectionReaderDescriptor

      public boolean isCollectionReaderDescriptor()
      Checks if is collection reader descriptor.
      Returns:
      true, if is collection reader descriptor

    • isCasInitializerDescriptor

      public boolean isCasInitializerDescriptor()
      Checks if is cas initializer descriptor.
      Returns:
      true, if is cas initializer descriptor

    • isCasConsumerDescriptor

      public boolean isCasConsumerDescriptor()
      Checks if is cas consumer descriptor.
      Returns:
      true, if is cas consumer descriptor

    • isLocalProcessingDescriptor

      public boolean isLocalProcessingDescriptor()
      Checks if is local processing descriptor.
      Returns:
      true, if is local processing descriptor

    • getAnalysisEngineMetaData

      protected AnalysisEngineMetaData getAnalysisEngineMetaData()
      Gets the analysis engine meta data.
      Returns:
      the analysis engine meta data