OverviewPage (Apache UIMA-AS Eclipse Plugin: uimaj-ep-deployeditor 2.4.2 API)

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.dde.internal.page.AbstractHeaderPage
        
        org.apache.uima.dde.internal.page.OverviewPage

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.part.IWorkbenchPartOrientation
```
public class OverviewPage
extends AbstractHeaderPage
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`OverviewPage.EnvVariableContentProvider` Content provider for the environment var table
`class`	`OverviewPage.EnvVariableLabelProvider` Label provider for the environment var table

Field Summary

Fields
Modifier and Type Field and Description

protected org.eclipse.swt.events.SelectionListener selectionListener
- Fields inherited from class org.apache.uima.dde.internal.page.AbstractHeaderPage
  STATUS_FILE_NOT_EXIST, STATUS_FILE_NOT_SPECIFIED, STATUS_IS_INVALID, STATUS_IS_VALID
- Fields inherited from interface org.eclipse.ui.IEditorPart
  PROP_DIRTY, PROP_INPUT
- Fields inherited from interface org.eclipse.ui.IWorkbenchPart
  PROP_TITLE

Fields
Modifier and Type	Field and Description
`protected org.eclipse.swt.events.SelectionListener`	`selectionListener`

Constructor Summary

Constructors
Constructor and Description

OverviewPage(DeploymentDescriptorEditor editor, String id, String title)

Constructors
Constructor and Description
`OverviewPage(DeploymentDescriptorEditor editor, String id, String title)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected boolean`	`addAndCheckVariable(org.apache.uima.aae.deployment.impl.NameValue variable)`
`protected void`	`createFormContent(org.eclipse.ui.forms.IManagedForm managedForm)` Called by the framework to fill in the contents
`org.apache.uima.resource.metadata.Import`	`createLocationImport(String location)`
`org.eclipse.swt.widgets.Button`	`createPushButton(org.eclipse.swt.widgets.Composite parent, String label, org.eclipse.swt.graphics.Image image, org.eclipse.ui.forms.widgets.FormToolkit toolkit)`
`protected void`	`createTableButtons(org.eclipse.swt.widgets.Composite parent, org.eclipse.ui.forms.widgets.FormToolkit toolkit)`
`protected void`	`createVerticalSpacer(org.eclipse.swt.widgets.Composite comp, int colSpan)` Create some empty space.
`void`	`enableCasPoolSizeSettings(boolean enable)`
`protected void`	`isValid()`
`void`	`setActive(boolean active)`
`void`	`setCasPoolSize(int number)`
`void`	`setInput(org.apache.uima.aae.deployment.AEDeploymentDescription aeDD)`
`protected void`	`showStatus(String msg, int msgType)`
`protected void`	`updateCPlusPlusSettings()` Enable C++ settings if top-level AE is C++
`protected void`	`updateEnvironmentVariables()`
`protected void`	`updateTopDescriptor(String fileFullPath, boolean byLocation)`
`static int`	`validateFilePath(String filePath)`

Methods inherited from class org.apache.uima.dde.internal.page.AbstractHeaderPage
createExpandOrCollapseAllMenu, createToolBarActions, setFormPageTitle

Methods inherited from class org.eclipse.ui.forms.editor.FormPage
canLeaveThePage, createPartControl, dispose, doSave, doSaveAs, getEditor, getId, getIndex, getManagedForm, getPartControl, getTitleImage, init, initialize, isActive, isDirty, isEditor, isSaveAsAllowed, selectReveal, 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
addPropertyListener, firePropertyChange, getAdapter, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getSite, getTitle, removePropertyListener, 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.ui.IEditorPart
getEditorInput, getEditorSite

Methods inherited from interface org.eclipse.ui.IWorkbenchPart
addPropertyListener, getSite, getTitle, getTitleToolTip, removePropertyListener

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

Methods inherited from interface org.eclipse.ui.ISaveablePart
isSaveOnCloseNeeded

Field Detail

selectionListener

protected org.eclipse.swt.events.SelectionListener selectionListener

Constructor Detail

OverviewPage

public OverviewPage(DeploymentDescriptorEditor editor,
            String id,
            String title)

Parameters:: editor -; id -; title -

Method Detail

enableCasPoolSizeSettings

public void enableCasPoolSizeSettings(boolean enable)

setCasPoolSize

public void setCasPoolSize(int number)

createFormContent
```
protected void createFormContent(org.eclipse.ui.forms.IManagedForm managedForm)
```
Called by the framework to fill in the contents

Overrides:

createFormContent in class org.eclipse.ui.forms.editor.FormPage

createTableButtons

protected void createTableButtons(org.eclipse.swt.widgets.Composite parent,
                      org.eclipse.ui.forms.widgets.FormToolkit toolkit)

createPushButton

public org.eclipse.swt.widgets.Button createPushButton(org.eclipse.swt.widgets.Composite parent,
                                              String label,
                                              org.eclipse.swt.graphics.Image image,
                                              org.eclipse.ui.forms.widgets.FormToolkit toolkit)

createVerticalSpacer

protected void createVerticalSpacer(org.eclipse.swt.widgets.Composite comp,
                        int colSpan)

Create some empty space.

updateTopDescriptor

protected void updateTopDescriptor(String fileFullPath,
                       boolean byLocation)

createLocationImport

public org.apache.uima.resource.metadata.Import createLocationImport(String location)
                                                              throws MalformedURLException

Parameters:: location -
Returns:
Throws:: MalformedURLException

setActive
```
public void setActive(boolean active)
```
Specified by:

setActive in interface org.eclipse.ui.forms.editor.IFormPage

Overrides:

setActive in class org.eclipse.ui.forms.editor.FormPage

isValid
```
protected void isValid()
```

showStatus

protected void showStatus(String msg,
              int msgType)

validateFilePath

public static int validateFilePath(String filePath)

setInput

public void setInput(org.apache.uima.aae.deployment.AEDeploymentDescription aeDD)

addAndCheckVariable

protected boolean addAndCheckVariable(org.apache.uima.aae.deployment.impl.NameValue variable)

updateEnvironmentVariables

protected void updateEnvironmentVariables()

updateCPlusPlusSettings
```
protected void updateCPlusPlusSettings()
```
Enable C++ settings if top-level AE is C++

Class OverviewPage

Nested Class Summary

Field Summary

Fields inherited from class org.apache.uima.dde.internal.page.AbstractHeaderPage

Fields inherited from interface org.eclipse.ui.IEditorPart

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

Constructor Summary

Method Summary

Methods inherited from class org.apache.uima.dde.internal.page.AbstractHeaderPage

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

Methods inherited from class org.eclipse.ui.part.EditorPart

Methods inherited from class org.eclipse.ui.part.WorkbenchPart

Methods inherited from class org.eclipse.core.commands.common.EventManager

Methods inherited from class java.lang.Object

Methods inherited from interface org.eclipse.ui.IEditorPart

Methods inherited from interface org.eclipse.ui.IWorkbenchPart

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

Methods inherited from interface org.eclipse.ui.ISaveablePart

Field Detail

selectionListener

Constructor Detail

OverviewPage

Method Detail

enableCasPoolSizeSettings

setCasPoolSize

createFormContent

createTableButtons

createPushButton

createVerticalSpacer

updateTopDescriptor

createLocationImport

setActive

isValid

showStatus

validateFilePath

setInput

addAndCheckVariable

updateEnvironmentVariables

updateCPlusPlusSettings