Overview

Package

Class

Use

Tree

Serialized

Deprecated

Index

Help

SWT LPEX
v3.0.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibm.lpex.alef
Class LpexStatusTextEditor

java.lang.Object
  org.eclipse.ui.part.WorkbenchPart
      org.eclipse.ui.part.EditorPart
          com.ibm.lpex.alef.LpexAbstractTextEditor
              com.ibm.lpex.alef.LpexStatusTextEditor

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, org.eclipse.ui.IEditorPart, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.ui.IReusableEditor, org.eclipse.ui.ISaveablePart, org.eclipse.ui.texteditor.ITextEditor, org.eclipse.ui.texteditor.ITextEditorExtension, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2

Direct Known Subclasses:

LpexAbstractDecoratedTextEditor

public class LpexStatusTextEditor

extends LpexAbstractTextEditor

A line-oriented, LPEX-based version of StatusTextEditor. A status text editor is capable of handling input elements that have an associated status.

Field Summary

Fields inherited from class com.ibm.lpex.alef.LpexAbstractTextEditor

ACTION_MAP, DEFAULT_EDITOR_CONTEXT_MENU_ID, DEFAULT_RULER_CONTEXT_MENU_ID, fErrorLabel, VERTICAL_RULER_WIDTH

Fields inherited from interface org.eclipse.ui.IEditorPart

PROP_DIRTY, PROP_INPUT

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

PROP_TITLE

Constructor Summary

LpexStatusTextEditor()

Method Summary

void	createPartControl(org.eclipse.swt.widgets.Composite parent) Creates the SWT controls for this workbench part.
protected org.eclipse.swt.widgets.Control	createStatusControl(org.eclipse.swt.widgets.Composite parent, org.eclipse.core.runtime.IStatus status) Creates the status control for the given status.
void	doRevertToSaved() Abandons all modifications applied to the editor's input element's textual presentation since the last save operation.
protected void	doSetInput(org.eclipse.ui.IEditorInput input) Internal processing of setting/changing the input to this editor.
protected String	getStatusBanner(org.eclipse.core.runtime.IStatus status) Returns a banner for the given status.
protected String	getStatusHeader(org.eclipse.core.runtime.IStatus status) Returns a header for the given status.
protected String	getStatusMessage(org.eclipse.core.runtime.IStatus status) Returns a message for the given status.
protected boolean	isErrorStatus(org.eclipse.core.runtime.IStatus status) Returns whether the given status indicates an error.
protected void	sanityCheckState(org.eclipse.ui.IEditorInput input) Checks the state of the given editor input.
void	updatePartControl(org.eclipse.ui.IEditorInput input) Checks whether the status of the given input is OK.
protected void	updateStatusField(String category) Updates the Eclipse status field for the given category.

Methods inherited from class com.ibm.lpex.alef.LpexAbstractTextEditor

addAction, addAction, addGroup, addLines, addRulerContextMenuListener, adjustHighlightRange, affectsTextPresentation, canHandleMove, close, createActions, createEmptyNavigationLocation, createNavigationActions, createNavigationLocation, createSourceViewer, createVerticalRuler, createViewPreferenceNodes, createViewPreferencePage, dispose, disposeDocumentProvider, doSave, doSaveAs, editorContextMenuAboutToShow, editorSaved, enableSanityChecking, enableStateValidation, firePropertyChange, getAction, getAdapter, getContextMenuListener, getCoverage, getCursorPosition, getDocumentProvider, getEditorContextMenuId, getEOL, getFirstLpexView, getFirstLpexWindow, getHelpContextId, getHighlightRange, getInputResource, getKeyBindingScopes, getLpexView, getLpexWindow, getPreferenceStore, getProgressMonitor, getRangeIndicator, getRulerContextMenuId, getRulerMouseListener, getSelectionProvider, getSourceViewer, getSourceViewerConfiguration, getStatusField, getVerticalRuler, handleDelegate, handleEditorInputChanged, handleElementContentReplaced, handleExceptionOnSave, handlePreferenceStoreChanged, init, initializeLpexView, internalInit, isChangeInformationShowing, isDirty, isEditable, isEditorInputModifiable, isEditorInputReadOnly, isSaveAsAllowed, isSaveOnCloseNeeded, isVisible, markAsPropertyDependentAction, markInNavigationHistory, modelOffset2WidgetOffset, performRevert, performSave, performSaveAs, performSaveAs, rememberSelection, removeActionActivationCode, removeRulerContextMenuListener, resetHighlightRange, restoreSelection, rulerContextMenuAboutToShow, safelySanityCheckState, selectAndReveal, setAction, setActionActivationCode, setCompatibilityMode, setDocumentProvider, setDocumentProvider, setDocumentSection, setEditorContextMenuId, setFocus, setHelpContextId, setHighlightRange, setInput, setKeyBindingScopes, setKeyBindingScopes, setLanguageHelp, setPreferenceStore, setRangeIndicator, setRulerContextMenuId, setSourceViewerConfiguration, setStatusField, showChangeInformation, showHighlightRangeOnly, showsHighlightRangeOnly, updateProfile, updateProfile, updatePropertyDependentActions, updateState, updateStatusFields, validateState, widgetContentsSet, widgetOffset2ModelOffset

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

getEditorInput, getEditorSite, getTitleToolTip, setContentDescription, setInitializationData, setPartName

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

addPropertyListener, getConfigurationElement, getContentDescription, getDefaultImage, getPartName, getSite, getTitle, getTitleImage, removePropertyListener, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy

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, getTitleImage, getTitleToolTip, removePropertyListener

Constructor Detail

LpexStatusTextEditor

public LpexStatusTextEditor()

Method Detail

createPartControl

public void createPartControl(org.eclipse.swt.widgets.Composite parent)

Creates the SWT controls for this workbench part. Clients should not call this method (the workbench calls this method when it needs to, which may be never).

For implementors, this is a multi-step process: 1. Create one or more controls within the parent; 2. Set the parent layout as needed; 3. Register any global actions with the IActionService; 4. Register any popup menus with the IActionService; 5. Register a selection provider with the ISelectionService (optional).

Specified by:

createPartControl in interface org.eclipse.ui.IWorkbenchPart

Overrides:

createPartControl in class LpexAbstractTextEditor

Parameters:

parent - the parent control

See Also:

IWorkbenchPart.createPartControl(org.eclipse.swt.widgets.Composite)

updatePartControl

public void updatePartControl(org.eclipse.ui.IEditorInput input)

Checks whether the status of the given input is OK. If not, the status control is shown rather than the default control.

Parameters:

input - the editor input whose status is checked

isErrorStatus

protected boolean isErrorStatus(org.eclipse.core.runtime.IStatus status)

Returns whether the given status indicates an error. Subclasses may override.

Parameters:

status - the status to be checked

Returns:

true if the status indicates an error, or
false otherwise

createStatusControl

protected org.eclipse.swt.widgets.Control createStatusControl(org.eclipse.swt.widgets.Composite parent,
                                                              org.eclipse.core.runtime.IStatus status)

Creates the status control for the given status. May be overridden by subclasses.

Parameters:

parent - the parent control

status - the status

Returns:

the new status control

getStatusHeader

protected String getStatusHeader(org.eclipse.core.runtime.IStatus status)

Returns a header for the given status.

Parameters:

status - the status whose message is returned

Returns:

a header for the given status

getStatusBanner

protected String getStatusBanner(org.eclipse.core.runtime.IStatus status)

Returns a banner for the given status.

Parameters:

status - the status whose message is returned

Returns:

a banner for the given status

getStatusMessage

protected String getStatusMessage(org.eclipse.core.runtime.IStatus status)

Returns a message for the given status.

Parameters:

status - the status whose message is returned

Returns:

a message for the given status

updateStatusField

protected void updateStatusField(String category)

Description copied from class: LpexAbstractTextEditor

Updates the Eclipse status field for the given category.

Overrides:

updateStatusField in class LpexAbstractTextEditor

Parameters:

category - the status category

doSetInput

protected void doSetInput(org.eclipse.ui.IEditorInput input)
                   throws org.eclipse.core.runtime.CoreException

Description copied from class: LpexAbstractTextEditor

Internal processing of setting/changing the input to this editor. Called from init() (shortly after the part construction), from setInput(), and from handleEditorInputChanged().

Overrides:

doSetInput in class LpexAbstractTextEditor

Parameters:

input - the (new) input to be set; if null, this text editor is being closed

Throws:

org.eclipse.core.runtime.CoreException - if the input cannot be connected to the document provider (i.e., it is not understood by this part)

doRevertToSaved

public void doRevertToSaved()

Description copied from class: LpexAbstractTextEditor

Abandons all modifications applied to the editor's input element's textual presentation since the last save operation.

The implementation of this ITextEditor method may be extended by subclasses.

Specified by:

doRevertToSaved in interface org.eclipse.ui.texteditor.ITextEditor

Overrides:

doRevertToSaved in class LpexAbstractTextEditor

See Also:

ITextEditor.doRevertToSaved()

sanityCheckState

protected void sanityCheckState(org.eclipse.ui.IEditorInput input)

Description copied from class: LpexAbstractTextEditor

Checks the state of the given editor input.

Overrides:

sanityCheckState in class LpexAbstractTextEditor

Parameters:

input - the editor input whose state is to be checked