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

Class ImportSection

java.lang.Object

org.eclipse.ui.forms.AbstractFormPart

org.eclipse.ui.forms.SectionPart

org.apache.uima.taeconfigurator.editors.ui.AbstractSection

org.apache.uima.taeconfigurator.editors.ui.ImportSection

All Implemented Interfaces:

StandardStrings, org.eclipse.swt.widgets.Listener, org.eclipse.ui.forms.IFormPart

Direct Known Subclasses:

ImportResBindSection, IndexImportSection, TypeImportSection, TypePriorityImportSection

public abstract class ImportSection
extends AbstractSection

Imports - used by aggregates types type priorities indexes external resource specifications.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.eclipse.swt.widgets.Button	addButton	The add button.
protected boolean	bDisableToolTipHelp	The b disable tool tip help.
protected org.eclipse.swt.widgets.TableItem	lastTableHoverItem	The last table hover item.
protected long	lLastTableHoverMillis	The l last table hover millis.
protected String	sLastTableHoverHelp	The s last table hover help.
protected static final long	TABLE_HOVER_REQUERY_TIME	The Constant TABLE_HOVER_REQUERY_TIME.

Fields inherited from class org.apache.uima.taeconfigurator.editors.ui.AbstractSection

capabilityArray0, configurationGroup0, configurationGroupArray0, configurationParameter0, configurationParameterArray0, editor, ENABLED, EQUAL_WIDTH, externalResourceBinding0, externalResourceDescription0, featureDescriptionArray0, fsIndexDescription0, HEADER_VISIBLE, HORIZONTAL_BUTTONS, IMPORTABLE_PART_CONTEXT, initialFormWidth, LINES_VISIBLE, nameValuePairArray0, NO_MIN_HEIGHT, NOT_SELECTED, NOTHING_SELECTED, PLUGIN_ID, SELECTED, sofaMapping0, stringArray0, toolkit, treeItemArray0, typeDescription0, typePriorityList0, valueChanged, VERTICAL_BUTTONS, WIDTH_NOT_SPECIFIED

Fields inherited from interface org.apache.uima.taeconfigurator.StandardStrings

S_, S_ADD, S_DESCRIPTION, S_DOWN, S_DOWN_TIP, S_EDIT, S_EDIT_TIP, S_EXPORT, S_EXPORT_TIP, S_REMOVE, S_REMOVE_TIP, S_UP, S_UP_TIP

Constructor Summary

Constructors

Constructor	Description
ImportSection(MultiPageEditor aEditor, org.eclipse.swt.widgets.Composite parent, String title, String description)	Instantiates a new import section.

Method Summary

Modifier and Type	Method	Description
boolean	addImports(Object[] locations, boolean isByName)	Called with either byLocation non-null or byName non-null Adds multiple (by location) or one (by name).
protected abstract void	clearModelBaseValue()	Clear model base value.
void	enable()	Enable.
protected void	exportImportablePart(String xmlStartElement, String partTemplate)	Export importable part.
protected abstract void	finishImportChangeAction()	Finish import change action.
protected abstract String	getDescriptionFromImport(String source)	Gets the description from import.
protected abstract Import[]	getModelImportArray()	Gets the model import array.
void	handleEvent(org.eclipse.swt.widgets.Event event)
void	handleRemove()	Handle remove.
void	initialize(org.eclipse.ui.forms.IManagedForm form)
protected abstract boolean	isAppropriate()	Checks if is appropriate.
protected abstract boolean	isValidImport(String title, String message)	Checks if is valid import.
void	refresh()
protected abstract void	setModelImportArray(Import[] newImports)	Sets the model import array.

Methods inherited from class org.apache.uima.taeconfigurator.editors.ui.AbstractSection

addCapabilitySet, addListenerForPastableWidget, convertNull, copyTableItem, copyTreeItem, createByNameImport, createImport, createLocationImport, enableBorders, enableCtrl, finishAggregateChangeAction, formatName, getAnalysisEngineMetaData, getAvailableTypeNames, getCapabilities, getCapabilities, getCapabilitySofaNames, getCapabilitySofaNames, getConfigurationParameterDeclarations, getDelegateAnalysisEngineSpecifiersWithImports, getDescriptionForDescriptor, getExternalResourceBindings, getExternalResourceDependencies, getExternalResources, getFeature, getFlowControllerDeclaration, getFsIndexCollection, getFsIndexDescriptionFromTableTreeItem, getIndex, getIndex, getItemIndex, getMergedTypeSystemDescription, getMetaDataFromDescription, getNameSpace, getOperationalProperties, getPreviousSelection, getResourceManagerConfiguration, getShortFeatureName, getShortName, getSofaMappings, getSofaMappings, getToolkit, getTypeFromFullFeatureName, getTypeOrFeature, getTypePriorities, getTypeSystemDescription, handleDefaultIndexKind, isAeDescriptor, isAggregate, isArrayOrListType, isCasConsumerDescriptor, isCasInitializerDescriptor, isCollectionReaderDescriptor, isExtResAndBindingsDescriptor, isFlowControllerDescriptor, isFSArrayOrListType, isIndexableRange, isIndexDescriptor, isJmsDescriptor, isLocalProcessingDescriptor, isParmGroup, isPrimitive, isTypePriorityDescriptor, isTypeSystemDescriptor, isValidAe, isValidAggregateChange, markRestOfPageStale, markStale, markStaleIfDifferent, maybeSetSelection, maybeShortenFileName, multiLineFix, new2ColumnComposite, new3ColumnComposite, new4ColumnComposite, newButtonContainer, newButtonContainer, newCComboWithTip, newCheckBox, newComposite, newDescriptionTextBox, newLabeledCComboWithTip, newLabeledTextField, newLabeledTextField, newLabelWithData, newLabelWithTip, newLabelWithTip, newNcolumnComposite, newPushButton, newPushButton, newPushButton, newRadioButton, newTable, newTable, newTable, newTableColumn, newTableColumn, newTableColumn, newTableColumn, newTextWithTip, newTextWithTip, newTree, newTree, newTreeColumn, newTreeColumn, newTreeColumn, newTreeColumn, newUnUpdatableTextWithTip, packTable, packTree, parseDescriptor, parseDescriptor, parseToFitInToolTips, produceUniqueComponentKey, readImport, removeChildren, requestPopUpOverImport, revertMsg, revertOrContinue, revertTypeSystem, setButtonSelection, setFileDirty, setFlowControllerDeclaration, setMargins, setSelectionOneUp, setToolTipText, setupToPrintFile, setValueChanged, setValueChangedBoolean, setValueChangedCapitalBoolean, setValueChangedInt, setValueChangedKeys, setVnsHostAndPort, setVnsHostAndPort, showExceptionReadingImportedDescriptor, spacer, stringArrayAdd, stringArrayRemove, swapIndexKeys, swapTableItems, swapTreeItems, typeOrFeatureArrayAdd, typeOrFeatureArrayRemove, typeOrFeatureArrayRemove

Methods inherited from class org.eclipse.ui.forms.SectionPart

expansionStateChanged, expansionStateChanging, getSection, hookListeners, setFocus

Methods inherited from class org.eclipse.ui.forms.AbstractFormPart

commit, dispose, getManagedForm, isDirty, isStale, markDirty, markStale, setFormInput

Methods inherited from class java.lang.Object

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

Field Details

TABLE_HOVER_REQUERY_TIME

protected static final long TABLE_HOVER_REQUERY_TIME

The Constant TABLE_HOVER_REQUERY_TIME.

See Also:

• Constant Field Values

lastTableHoverItem

protected org.eclipse.swt.widgets.TableItem lastTableHoverItem

The last table hover item.

lLastTableHoverMillis

protected long lLastTableHoverMillis

The l last table hover millis.

sLastTableHoverHelp

protected String sLastTableHoverHelp

The s last table hover help.

bDisableToolTipHelp

protected boolean bDisableToolTipHelp

The b disable tool tip help.

addButton

protected org.eclipse.swt.widgets.Button addButton

The add button.

Constructor Details

ImportSection

public ImportSection(MultiPageEditor aEditor,
 org.eclipse.swt.widgets.Composite parent,
 String title,
 String description)

Instantiates a new import section.

Parameters:

aEditor - the a editor

parent - the parent

title - the title

description - the description

Method Details

getModelImportArray

protected abstract Import[] getModelImportArray()

Gets the model import array.

Returns:

the model import array

setModelImportArray

protected abstract void setModelImportArray(Import[] newImports)

Sets the model import array.

Parameters:

newImports - the new model import array

isValidImport

protected abstract boolean isValidImport(String title,
 String message)

Checks if is valid import.

Parameters:

title - the title

message - the message

Returns:

true, if is valid import

finishImportChangeAction

protected abstract void finishImportChangeAction()

Finish import change action.

getDescriptionFromImport

protected abstract String getDescriptionFromImport(String source)
                                            throws InvalidXMLException,
IOException

Gets the description from import.

Parameters:

source - the source

Returns:

the description from import

Throws:

InvalidXMLException - the invalid XML exception

IOException - Signals that an I/O exception has occurred.

isAppropriate

protected abstract boolean isAppropriate()

Checks if is appropriate.

Returns:

true, if is appropriate

clearModelBaseValue

protected abstract void clearModelBaseValue()

Clear model base value.

initialize

public void initialize(org.eclipse.ui.forms.IManagedForm form)

Specified by:

initialize in interface org.eclipse.ui.forms.IFormPart

Overrides:

initialize in class AbstractSection

refresh

public void refresh()

Specified by:

refresh in interface org.eclipse.ui.forms.IFormPart

Overrides:

refresh in class org.eclipse.ui.forms.AbstractFormPart

handleEvent

public void handleEvent(org.eclipse.swt.widgets.Event event)

handleRemove

public void handleRemove()

Handle remove.

addImports

public boolean addImports(Object[] locations,
 boolean isByName)

Called with either byLocation non-null or byName non-null Adds multiple (by location) or one (by name).

Parameters:

locations - objects returned from dialog

isByName - true if imports should be done by name

Returns:

false if any import caused an error, true of all OK

enable

public void enable()

Description copied from class: AbstractSection

Enable.

Specified by:

enable in class AbstractSection

exportImportablePart

protected void exportImportablePart(String xmlStartElement,
 String partTemplate)

Export importable part.

Parameters:

xmlStartElement - first element exported

partTemplate - the part template