Class PropEditorPart
- All Implemented Interfaces:
IActivationListener
,IDraggingFix
,IWorkbenchPartIZ
,IPropertyEditorController
,IPropUndoContext
,IDisposedPart
,IPropUndoRedo
,IAdaptable
,IExecutableExtension
,ISelectionChangedListener
,ISelectionProvider
,IGotoMarker
,IEditorPart
,INavigationLocationProvider
,IPersistable
,IPersistableEditor
,ISaveablePart
,ISaveablesSource
,IWorkbenchPart
,IWorkbenchPart2
,IWorkbenchPart3
,IWorkbenchPartOrientation
- Direct Known Subclasses:
CaptureEditor
,ContextMenuEditor
,DatabaseEditor
,FontFacesEditor
,ImageDefinitionEditor
,PanelEditor
,RecordingEditor
,ScreenEditor
,SelectorEditor
,StyleEditor
,TextTableEditor
,VirtualSpaceEditor
,WebServiceEditor
- Author:
- Christopher Mindus
Nested Class Summary
Modifier and TypeClassDescriptionprotected final class
Class used to delegate DragSource events to the listener, making it possible to know when drag-drop is in effect.Field Summary
Modifier and TypeFieldDescriptionprotected ApplicationUI
The Application UI.protected PartAction
Menu actions.protected PartAction
protected PartAction
Menu actions that MAY be null in case they are not supported.protected PartAction
Menu actions.protected PartAction
Menu actions.protected DropdownSelectionListener
protected PropCnr
The edited property inside thefilePropCnr
.static final PropEditorPart[]
Empty array.protected FilePropCnr
The File Property being edited, null for none.protected IFile
The file resource for the editor.protected IActionBars
The global action bars.protected final ImageRegistry
The Image Registry.protected PartAction
Menu actions.protected PartAction
Menu actions.protected IStructuredSelection
This part's current selection.protected PartAction
Menu actions.protected PartAction
Menu actions.protected PartAction
Menu actions.protected PartAction
Menu actions.protected PartAction
Menu actions.protected final EventListener
Property event listener.protected RedoActionHandler
protected PartAction
Menu actions.protected IMemento
The restored memento.protected PartAction
Menu actions.protected PropCnr
The (Module) root container used to listen to events, null when not used.protected PartAction
Menu actions.protected PartAction
Menu actions.protected SelectionEnabler
The last selection states.protected ToolItem
Paste items.protected ToolBar
The tool bar.protected ToolBar
The tool bar.protected UndoActionHandler
final Runnable
The update states runnable.Fields inherited from interface org.eclipse.ui.IEditorPart
PROP_DIRTY, PROP_INPUT
Fields inherited from interface org.eclipse.ui.IWorkbenchPart
PROP_TITLE
Constructor Summary
Method Summary
Modifier and TypeMethodDescriptionprotected void
addForDisposalAtDispose
(Object disposable) Adds an action that is disposed when the editor is disposed of.static boolean
addListener
(ILicenseSystemError listener) Adds a dispose listener for the client session.protected void
addOpenFile
(FilePropCnr fpc) Adds an open file.void
Adds a listener for selection changes in this selection provider.protected ToolItem
addToolbar2PushButton
(String tooltip, Image image, Listener listener) Adds a tool bar push button to the second tool bar.protected void
addToolbar2PushButton
(IAction action) Adds a push button to the second tool bar from an action.protected void
Adds a separator to the second tool bar.protected ToolItem
addToolbarPushButton
(String tooltip, String icon, Listener listener) Adds a tool bar push button.protected ToolItem
addToolbarPushButton
(String tooltip, Image image, Listener listener) Adds a tool bar push button.protected void
addToolbarPushButton
(IAction action) Adds a tool bar push button from an action.static ToolItem
addToolbarPushButton
(ToolBar toolBar, String tooltip, String icon, Listener listener) Adds a tool bar push button.static ToolItem
addToolbarPushButton
(ToolBar toolBar, String tooltip, Image image, int style, Listener listener) Adds a tool bar push button to the second tool bar.static ToolItem
addToolbarPushButton
(ToolBar toolBar, String tooltip, Image image, Listener listener) Adds a tool bar push button to the second tool bar.void
addToolbarPushButton
(ToolBar toolBar, IAction action) Adds a tool bar push button from an action.protected void
Adds a separator to the tool bar.static void
addToolbarSeparator
(ToolBar toolBar) Adds a separator to the tool bar.protected void
closeFile
(FilePropCnr fpc) Closed an open file.final CommonViewerEx
createCommonViewer
(Composite parent) Creates the CommonViewer with extra support for Drag-and-Drop.protected abstract void
createEditorComposite
(Composite parent) Creates the Editor Main Composite.Creates an empty navigation location.final FilteredCommonViewer
createFilteredCommonViewer
(Composite parent, int style, IzFilter filter) Creates the Filtered CommonViewer with extra support for Drag-and-Drop.final FilteredCommonViewer
createFilteredCommonViewer
(Composite parent, IzFilter filter) Creates the Filtered CommonViewer with extra support for Drag-and-Drop.static Composite
createLicenseExceptionComposite
(Composite parent, String errorText) Creates an error composite from the license exception.protected void
createMenu
(Viewer viewer, IContextMenuContributor contributor) Creates a menu that is used as a pop-up menu.protected void
createMenu
(Control control, IContextMenuContributorFormControl<Control> contributor) Creates a menu that is used as a pop-up menu.Creates a navigation location describing the current state.final void
createPartControl
(Composite parent) Create contents of the editor part.void
dispose()
Disposes of the Editor.boolean
Opens the property by selecting it in focus.boolean
Opens the property by selecting it in focus.void
doSave
(IProgressMonitor monitor) Saves the contents of this part.final void
doSaveAs()
Saves the contents of this part to another object.void
Fires a new selection event that also updates the states.static PropEditorPart
Gets the active editor part.static PropEditorPart
getActiveEditor
(GProp<?> prop) Gets the active or topmost editor from a property.static PropEditorPart
Gets the active part, differs fromgetActiveEditor()
because it check if e.g.Saveable[]
<T> T
getAdapter
(Class<T> adapter) protected TreeViewer
Gets the current tree viewer.static PropEditorPart[]
Gets a snapshot of the editor parts.The extensions framework.static LicenseException
Gets the potential license exception that occurred when loading it.Gets the ModuleModel instance of the project.final MultiSelectionProvider
Gets the multi-property selection provider.Gets the part composite created.protected String
getPartName
(String title) Gets the part name that is about to be set.Gets the undo action.Saveable[]
Returns the current selection for this provider.Gets the selection enabler instance.final Shell
getShell()
Gets the shell.Gets the current IClipboardSelection implementor.Gets the structured viewer (common, tree or table) used for the property operation (add, delete, etc).Returns the workbench part image.Returns the title tooltip.protected String
getTitleToolTip
(String title) Gets the part name that is about to be set.static PropEditorPart
getTopmostEditor
(PropEditorPart[] editors) Gets the topmost editor part from an array of editors.Gets the undo action.final IUndoContext
Gets the undo context.final IPropUndoRedo
Gets the undo/redo interface.void
gotoMarker
(IMarker marker) Sets the cursor and selection state for an editor to reveal the position of the given marker.boolean
Flag for initialize error, i.e.final void
init
(IEditorSite site, IEditorInput input) Initializes this editor with the given editor site and input.protected void
initEditor
(PropCnr cnr) The initialize editor method.static void
Called from the SWT thread if the license is not valid.boolean
isDirty()
Returns whether the contents of this part have changed since the last save operation.boolean
Checks if the part is disposed of.boolean
Flag for dragging to postpone selection events until drag completes.final boolean
Returns whether the "Save As" operation is supported by this part.boolean
Returns whether the contents of this editor should be saved when the editor is closed.final void
onActivated
(boolean on) Called when activator or deactivated.void
onClose()
Called when the part is being closed but is not yet disposed but hidden.static void
onCloseProject
(IProject project) Called when a project is closed or unregistered from being a Module project.void
Called by the workbench extension when focus is received.protected void
Drag started.protected void
Drag finished.protected void
Called when verification listener gets called for verify, very commonly in a non-SWT thread.protected void
onEditorActivated
(boolean on) Called when the editor is activated or deactivated.protected void
Function called once the Editor has been initialized and fully created, should be overridden by Editor parts that need such functionality.protected void
onFileClosed
(FilePropCnr fpc) Called when an open file in the editor has been closed and needs to be removed.protected void
Called when the part has been renamed.protected void
Called when set focus is called to override default processing.protected void
Called just in the beginning of updateStates() before selections are processed.protected void
Performs move up.void
Performs Copy.protected boolean
performCopyFullPath
(boolean doPerform) Copies the full path.protected boolean
performCopyReference
(boolean doPerform) Copies the reference.void
Performs Cut.void
Performs Delete.protected void
Performs move down.void
Performs Link.void
Performs Move.void
Performs Paste.void
Performs Paste Before.void
Performs Paste Before.void
Performs Paste-link.protected abstract void
Performs Print.void
Performs Redo.protected void
Performs Rename.protected void
Performs Revert.protected void
Performs Save.final void
Performs Select All.void
Performs Undo.protected final void
Post an async updateStates event (once only in one "SWT cycle").protected void
Continues the "init".protected void
Proceeds initializing the editor with the property.void
Refreshes all registered viewers before e.g.void
registerFormControl
(Control control) Registers a form entry capable control in the Editor part.protected void
registerViewer
(StructuredViewer viewer, int index) Registers a viewer for selection changes.void
registerViewer
(StructuredViewer viewer, int index, IContextMenuContributor contributor) Registers a viewer for selection changes.static boolean
removeListener
(ILicenseSystemError listener) Removes a dispose listener for the client session.void
removePropertyValue
(GProp<?> property) Removes a property when undefined in the editors.void
Removes the given selection change listener from this selection provider.protected void
Called to perform the restoring of the Memento state.final void
restoreState
(IMemento memento) Called with a memento for this editor.final void
Saves the state of the object in the given memento.protected void
saveStateImpl
(IMemento memento) Saves the state of the object in the given memento.final void
Selection changes in the tree.protected void
Selection changes in the tree.void
setActionsUndoContext
(IUndoContext undoContext) Assigns another undo context to the undo/redo actions.void
setBlockViewerFocus
(boolean block) Blocks the target viewer from focus.final void
setFocus()
Sets focus to the Editor.protected int
setFocus
(PropCnr container, StructuredViewer viewer, IzFilter filter, PropertyEditor propertyEditor, GProp<?> property, int index, String childName) Attempts to set focus to the property in question based on a container, a viewer and a property editor.void
setPropertyAttrFlag
(GProp<?> property, int attr, boolean flag) Sets a property attribute flag.void
setPropertyError
(GProp<?> property, String errorID, IPropErrorItem item) Sets a property error.void
setPropertyValue
(PropCnr parent, GProp<?> property, Object value) Sets a property value.void
setSelection
(ISelection selection) Sets the current selection for this selection provider.final void
setTargetViewer
(Object viewer) Sets the target viewer for e.g.protected boolean
Returns if the Copy path should be present or not.protected boolean
Returns if the Copy reference should be present or not.static void
Updates the states of all created editors.final void
Update states of the menu and tool bars, both global and part-local ones.protected void
Update states of the menu and tool bars, both global and part-local ones.protected void
Process update states for pasteBeforeAction and pasteAfterAction.protected void
Updates the title and tooltip when file name/contents changes.protected boolean
Override to return how paste before/after are processed.void
Verifies the dirty and fires state changed as required.Methods inherited from class org.eclipse.ui.part.EditorPart
checkSite, getEditorInput, getEditorSite, setContentDescription, setInitializationData, setInput, setInputWithNotify, setPartName
Methods inherited from class org.eclipse.ui.part.WorkbenchPart
addPartPropertyListener, addPropertyListener, firePartPropertyChanged, firePropertyChange, 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.ui.IWorkbenchPart
addPropertyListener, getSite, getTitle, removePropertyListener
Methods inherited from interface com.iizigo.editor.IWorkbenchPartIZ
onComponentFocused
Field Details
EMPTY
Empty array.rootPropCnr
The (Module) root container used to listen to events, null when not used.fileResource
The file resource for the editor.filePropCnr
The File Property being edited, null for none.editedPropCnr
The edited property inside thefilePropCnr
.toolBar
The tool bar.toolBar2
The tool bar.partSelection
This part's current selection.selectionEnabler
The last selection states.cutAction
Menu actions.copyAction
Menu actions.pasteAction
Menu actions.pasteBeforeAction
Menu actions.pasteAfterAction
Menu actions.pasteLinkAction
Menu actions.deleteAction
Menu actions.selectAllAction
Menu actions.revertAction
Menu actions.saveAction
Menu actions.renameAction
Menu actions.moveAction
Menu actions.linkAction
Menu actions.printAction
Menu actions.copyReferenceAction
Menu actions that MAY be null in case they are not supported.copyFullPathAction
undoAction
redoAction
tiPaste
Paste items.dslPaste
globalActionBars
The global action bars.ir
The Image Registry.appUI
The Application UI.restoreMemento
The restored memento.Note that
restoreMemento
may benull
.propEventListener
Property event listener.updateSelectionAndStatesRunner
The update states runnable.
Constructor Details
PropEditorPart
Constructor.- Parameters:
propertyClass
- The property class in files.
Method Details
getEditors
Gets a snapshot of the editor parts.updateAllStates
public static void updateAllStates()Updates the states of all created editors.getActiveEditor
Gets the active editor part.- Returns:
- The active editor part, or null for none.
getActiveEditor
Gets the active or topmost editor from a property.- Returns:
- null if none is found.
getTopmostEditor
Gets the topmost editor part from an array of editors.- Parameters:
editors
- Selection of editors to choose from, in the order of first created editor.- Returns:
- The topmost editor, or null if no editor is found (editors array is empty).
getActivePart
Gets the active part, differs fromgetActiveEditor()
because it check if e.g. a Common Navigator is active...- Returns:
- The active editor part, or null for none.
onCloseProject
Called when a project is closed or unregistered from being a Module project. This closes the editors for it!addListener
Adds a dispose listener for the client session. Calling this method multiple times with the same listener will have no effect (but to return false).- Parameters:
listener
- The listener to add.- Returns:
- true if the listener was added, false otherwise.
- Throws:
NullPointerException
- If the listener isnull
.
removeListener
Removes a dispose listener for the client session.- Parameters:
listener
- The listener to remove.- Returns:
- true if listener is successfully removed, false otherwise.
invalidLicense
Called from the SWT thread if the license is not valid.- Parameters:
e
- The license exception.
getLicenseException
Gets the potential license exception that occurred when loading it.- Returns:
- The license exception, or null for OK (or License System not yet loaded).
createLicenseExceptionComposite
Creates an error composite from the license exception.- Parameters:
parent
- The parent composite.errorText
- The error text to use if there is no license exception.- Returns:
- The error composite, or null for no exception and no error text.
addForDisposalAtDispose
Adds an action that is disposed when the editor is disposed of.getMultiSelectionProvider
Gets the multi-property selection provider.- Specified by:
getMultiSelectionProvider
in interfaceIPropertyEditorController
getExtension
The extensions framework.- Specified by:
getExtension
in interfaceIWorkbenchPartIZ
getSelectionEnabler
Gets the selection enabler instance.- Specified by:
getSelectionEnabler
in interfaceIWorkbenchPartIZ
onEditorActivated
protected void onEditorActivated(boolean on) Called when the editor is activated or deactivated.addOpenFile
Adds an open file. This method should be called when e.g. the text table editor opens a parallel text table for editing.closeFile
Closed an open file. This method should be called when e.g. the text table editor opens a parallel text table for editing.init
Initializes this editor with the given editor site and input.This method is automatically called shortly after the part is instantiated. It marks the start of the part's life cycle. The IWorkbenchPart.dispose method will be called automatically at the end of the life cycle. Clients must not call this method.
Implementors of this method must examine the editor input object type to determine if it is understood. If not, the implementor must throw a PartInitException.
The initEditor method is called once initialized.
- Specified by:
init
in interfaceIEditorPart
- Specified by:
init
in classEditorPart
- Throws:
PartInitException
- For initialization failures.
hasInitError
public boolean hasInitError()Flag for initialize error, i.e. if there is a PartInitException in the postponed call.onEditorReady
protected void onEditorReady()Function called once the Editor has been initialized and fully created, should be overridden by Editor parts that need such functionality. By default nothing is done in this method.proceedInit
Continues the "init". This method can be overridden by editors that are not file property based such as the capture editor.- Throws:
PartInitException
proceedInitProperty
Proceeds initializing the editor with the property.- Throws:
PartInitException
getPartComposite
Gets the part composite created.- Returns:
- The part composite, null if not yet created.
updateTitle
protected void updateTitle()Updates the title and tooltip when file name/contents changes.getTitleToolTip
Returns the title tooltip.- Specified by:
getTitleToolTip
in interfaceIWorkbenchPart
- Overrides:
getTitleToolTip
in classEditorPart
getTitleImage
Returns the workbench part image.- Specified by:
getTitleImage
in interfaceIWorkbenchPart
- Overrides:
getTitleImage
in classWorkbenchPart
getPartName
Gets the part name that is about to be set. Override to provide an other title.getTitleToolTip
Gets the part name that is about to be set. Override to provide an other title.getModuleModel
Gets the ModuleModel instance of the project.- Specified by:
getModuleModel
in interfaceIPropertyEditorController
- Returns:
- The ModuleModel of the project, null if not yet loaded.
onFileClosed
Called when an open file in the editor has been closed and needs to be removed. This is called in the SWT thread. This call is not done for the main file of this editor, but secondary files. For the main file, the editor is closed directory.Subclasses with multiple files override this method.
- Parameters:
fpc
- The file closed.
onPartRenamed
Called when the part has been renamed. Subclasses override this method to handle changes in property names if the property e.g. is in a tree.initEditor
The initialize editor method.Subclasses may override this method.
- Parameters:
cnr
- The property container being edited. Note: the real name of the property is in the parent FilePropCnr Atom.- Throws:
PartInitException
- For initialization failures.
onClose
public void onClose()Called when the part is being closed but is not yet disposed but hidden.- Specified by:
onClose
in interfaceIActivationListener
isSaveOnCloseNeeded
public boolean isSaveOnCloseNeeded()Returns whether the contents of this editor should be saved when the editor is closed.This method always returns
false
because the IIZI saveables mechanism is somewhat different and saves when workspace exits.- Specified by:
isSaveOnCloseNeeded
in interfaceISaveablePart
- Overrides:
isSaveOnCloseNeeded
in classEditorPart
dispose
public void dispose()Disposes of the Editor.- Specified by:
dispose
in interfaceIWorkbenchPart
- Overrides:
dispose
in classWorkbenchPart
isDisposed
public boolean isDisposed()Checks if the part is disposed of.- Specified by:
isDisposed
in interfaceIActivationListener
- Specified by:
isDisposed
in interfaceIDisposedPart
- Specified by:
isDisposed
in interfaceIPropertyEditorController
- Specified by:
isDisposed
in interfaceIWorkbenchPartIZ
- Returns:
- true if disposed of, false otherwise.
restoreState
Called with a memento for this editor. The editor can parse the data or save the memento. This method may not be called.- Specified by:
restoreState
in interfaceIPersistableEditor
- Parameters:
memento
- the saved state for this editor. May benull
.
restoreMemento
protected void restoreMemento()Called to perform the restoring of the Memento state. When this method is called, the subclass can get the memento using the protected variablerestoreMemento
.Note that
restoreMemento
may benull
.saveState
Saves the state of the object in the given memento.Subclasses may extend this method.
- Specified by:
saveState
in interfaceIPersistable
- Parameters:
memento
- The storage area for object's state.
saveStateImpl
Saves the state of the object in the given memento.Subclasses should override this method to provide support.
- Parameters:
memento
- The storage area for object's state.
addSelectionChangedListener
Adds a listener for selection changes in this selection provider. Has no effect if an identical listener is already registered.- Specified by:
addSelectionChangedListener
in interfaceISelectionProvider
- Parameters:
listener
- a selection changed listener
removeSelectionChangedListener
Removes the given selection change listener from this selection provider. Has no effect if an identical listener is not registered.- Specified by:
removeSelectionChangedListener
in interfaceISelectionProvider
- Parameters:
listener
- a selection changed listener
getSelection
Returns the current selection for this provider.- Specified by:
getSelection
in interfaceISelectionProvider
- Returns:
- the current selection
setSelection
Sets the current selection for this selection provider.- Specified by:
setSelection
in interfaceISelectionProvider
- Parameters:
selection
- the new selection
addToolbarPushButton
public static ToolItem addToolbarPushButton(ToolBar toolBar, String tooltip, Image image, int style, Listener listener) Adds a tool bar push button to the second tool bar.- Parameters:
toolBar
- The tool bar.tooltip
- The tool-tip text of the tool bar button.image
- The image to use for the tool bar button.style
- The style: SWT.PUSH, SWT.CHECK, etc...listener
- The listener for the tool bar button.
addToolbarPushButton
public static ToolItem addToolbarPushButton(ToolBar toolBar, String tooltip, Image image, Listener listener) Adds a tool bar push button to the second tool bar.- Parameters:
toolBar
- The tool bar.tooltip
- The tool-tip text of the tool bar button.image
- The image to use for the tool bar button.listener
- The listener for the tool bar button.
addToolbarPushButton
public static ToolItem addToolbarPushButton(ToolBar toolBar, String tooltip, String icon, Listener listener) Adds a tool bar push button.- Parameters:
toolBar
- The tool bar.tooltip
- The tool-tip text of the tool bar item.icon
- The workbench predefined image name.listener
- The listener for the tool bar button.- Returns:
- The newly created tool bar button.
addToolbarPushButton
Adds a tool bar push button.- Parameters:
tooltip
- The tool-tip text of the tool bar button.image
- The image to use for the tool bar button.listener
- The listener for the tool bar button.
addToolbarPushButton
Adds a tool bar push button.- Parameters:
tooltip
- The tool-tip text of the tool bar item.icon
- The workbench predefined image name.listener
- The listener for the tool bar button.- Returns:
- The newly created tool bar button.
addToolbarPushButton
Adds a tool bar push button from an action.- Parameters:
toolBar
- The tool bar.action
- The action.
addToolbarPushButton
Adds a tool bar push button from an action.- Parameters:
action
- The action.
addToolbar2PushButton
Adds a push button to the second tool bar from an action.- Parameters:
action
- The action.
addToolbar2PushButton
Adds a tool bar push button to the second tool bar.- Parameters:
tooltip
- The tool-tip text of the tool bar button.image
- The image to use for the tool bar button.listener
- The listener for the tool bar button.
addToolbarSeparator
Adds a separator to the tool bar.- Parameters:
toolBar
- The tool bar.
addToolbarSeparator
protected void addToolbarSeparator()Adds a separator to the tool bar.addToolbar2Separator
protected void addToolbar2Separator()Adds a separator to the second tool bar.createPartControl
Create contents of the editor part.This method calls .
- Specified by:
createPartControl
in interfaceIWorkbenchPart
- Specified by:
createPartControl
in classWorkbenchPart
- Parameters:
parent
- The parent composite.
supportsCopyReference
protected boolean supportsCopyReference()Returns if the Copy reference should be present or not.- Returns:
- false indicates no such item should be present, true for maybe, depending on selection.
supportsCopyFullPath
protected boolean supportsCopyFullPath()Returns if the Copy path should be present or not.- Returns:
- false indicates no such item should be present, true for maybe, depending on selection.
usePasteBeforeAfter
protected boolean usePasteBeforeAfter()Override to return how paste before/after are processed.- Returns:
- true to handle before/after.
createEditorComposite
Creates the Editor Main Composite.- Parameters:
parent
- The empty parent composite without initialized layout, with the widget background color.
performCopyReference
protected boolean performCopyReference(boolean doPerform) Copies the reference.- Parameters:
doPerform
- Flag to perform the action or just testing it.- Returns:
- true for action enabled, false for disabled.
performCopyFullPath
protected boolean performCopyFullPath(boolean doPerform) Copies the full path.- Parameters:
doPerform
- Flag to perform the action or just testing it.- Returns:
- true for action enabled, false for disabled.
setActionsUndoContext
Assigns another undo context to the undo/redo actions.- Parameters:
undoContext
- The new undo context, or null to restore to the original one.
getUndoAction
Gets the undo action.getRedoAction
Gets the undo action.registerFormControl
Registers a form entry capable control in the Editor part.- Parameters:
control
- The control can be Text, Combo, CCombo, StyledText, Spinner.
getShell
Gets the shell.- Specified by:
getShell
in interfaceIPropUndoRedo
- Returns:
- An object castable to org.eclipse.swt.widgets.Shell.
getUndoContext
Gets the undo context.- Specified by:
getUndoContext
in interfaceIPropertyEditorController
- Specified by:
getUndoContext
in interfaceIPropUndoContext
- Specified by:
getUndoContext
in interfaceIPropUndoRedo
- Returns:
- An object castable to org.eclipse.core.commands.operations.IUndoContext.
getUndoRedo
Gets the undo/redo interface.- Specified by:
getUndoRedo
in interfaceIPropertyEditorController
- Specified by:
getUndoRedo
in interfaceIWorkbenchPartIZ
isDirty
public boolean isDirty()Returns whether the contents of this part have changed since the last save operation. If this value changes the part must fire a property listener event with PROP_DIRTY.- Specified by:
isDirty
in interfaceISaveablePart
- Specified by:
isDirty
in classEditorPart
verifyDirtyStateChanged
public void verifyDirtyStateChanged()Verifies the dirty and fires state changed as required.refreshViewers
public void refreshViewers()Refreshes all registered viewers before e.g. a "doOpen" call to show a property when they have just been added.doOpen
Opens the property by selecting it in focus. This method must be overridden.doOpen
Opens the property by selecting it in focus. This method must be overridden.- Parameters:
prop
- The property to focus.index
- The index in a multi-property.childName
- The child property name or null.- Returns:
- true for success, false for failure.
doSave
Saves the contents of this part.If the save is successful, the part should fire a property changed event reflecting the new dirty state (PROP_DIRTY property). If the save is cancelled through user action, or for any other reason, the part should invoke setCancelled on the IProgressMonitor to inform the caller.
- Specified by:
doSave
in interfaceISaveablePart
- Specified by:
doSave
in classEditorPart
doSaveAs
public final void doSaveAs()Saves the contents of this part to another object.This is not supported.
- Specified by:
doSaveAs
in interfaceISaveablePart
- Specified by:
doSaveAs
in classEditorPart
isSaveAsAllowed
public final boolean isSaveAsAllowed()Returns whether the "Save As" operation is supported by this part.- Specified by:
isSaveAsAllowed
in interfaceISaveablePart
- Specified by:
isSaveAsAllowed
in classEditorPart
- Returns:
- false, always.
performUndo
public void performUndo()Performs Undo.performRedo
public void performRedo()Performs Redo.getSyntClipboardSelection
Gets the current IClipboardSelection implementor.- Returns:
- null For none.
performCopy
public void performCopy()Performs Copy.performCut
public void performCut()Performs Cut.performPaste
public void performPaste()Performs Paste.performPasteBefore
public void performPasteBefore()Performs Paste Before.performPasteAfter
public void performPasteAfter()Performs Paste Before.performPasteLink
public void performPasteLink()Performs Paste-link.performDelete
public void performDelete()Performs Delete.performSelectAll
public final void performSelectAll()Performs Select All.performMove
public void performMove()Performs Move.performLink
public void performLink()Performs Link.performPrint
protected abstract void performPrint()Performs Print.performRevert
protected void performRevert()Performs Revert.performSave
protected void performSave()Performs Save.performRename
protected void performRename()Performs Rename.getCurrentTreeViewer
Gets the current tree viewer.- Returns:
- null for none.
performCollapseAll
protected void performCollapseAll()Performs move up.performExpandAll
protected void performExpandAll()Performs move down.selectionChanged
Selection changes in the tree. Once the selection has been processed, theselectChangedEx(event)
method is called.- Specified by:
selectionChanged
in interfaceISelectionChangedListener
fireSelectionAndStates
public void fireSelectionAndStates()Fires a new selection event that also updates the states.selectionChangedEx
Selection changes in the tree.Subclasses should override this method to process selection changes.
updateStates
public final void updateStates()Update states of the menu and tool bars, both global and part-local ones. The states are set according to theselectionStates
member variable class instance. To fine-tune the states in theselectionStates
and further process other states, override theupdateStatesEx()
method.- Specified by:
updateStates
in interfaceIActivationListener
- Specified by:
updateStates
in interfaceIPropUndoRedo
onUpdateStates
protected void onUpdateStates()Called just in the beginning of updateStates() before selections are processed. Override as required.updateStatesPasteBeforeAfter
protected void updateStatesPasteBeforeAfter()Process update states for pasteBeforeAction and pasteAfterAction. Override if other processing that the default is required, such as in the Panel Editor.postAsyncUpdateStates
protected final void postAsyncUpdateStates()Post an async updateStates event (once only in one "SWT cycle").onEditedPropertyChangedForVerify
Called when verification listener gets called for verify, very commonly in a non-SWT thread. This method does nothing by default and can be overridden to process the edited property container changes events.updateStatesEx
protected void updateStatesEx()Update states of the menu and tool bars, both global and part-local ones. The states are set according to theselectionStates
member variable class instance.To fine-tune the states in the
selectionStates
and further process other states, override this method.setPropertyValue
Sets a property value. The undo/redo functionality will wrap an undo/redo action for this function. This method handles setting a property value that is extended in the parent and the new property is to replace it in the parent.- Specified by:
setPropertyValue
in interfaceIPropertyEditorController
setPropertyError
Sets a property error. The undo/redo functionality will wrap an undo/redo action for this function.- Specified by:
setPropertyError
in interfaceIPropertyEditorController
setPropertyAttrFlag
Sets a property attribute flag. The undo/redo functionality will wrap an undo/redo action for this function.- Specified by:
setPropertyAttrFlag
in interfaceIPropertyEditorController
removePropertyValue
Removes a property when undefined in the editors. The undo/redo functionality will wrap an undo/redo action for this function.- Specified by:
removePropertyValue
in interfaceIPropertyEditorController
getAdapter
- Specified by:
getAdapter
in interfaceIAdaptable
- Overrides:
getAdapter
in classWorkbenchPart
getSaveables
- Specified by:
getSaveables
in interfaceISaveablesSource
getActiveSaveables
- Specified by:
getActiveSaveables
in interfaceISaveablesSource
onActivated
public final void onActivated(boolean on) Called when activator or deactivated.- Specified by:
onActivated
in interfaceIActivationListener
createCommonViewer
Creates the CommonViewer with extra support for Drag-and-Drop. The Tree Control gets an added focus listener to this instance as well as the viewer getting a post-selection listener.- Parameters:
parent
- The parent.- Returns:
- The common viewer registered as "com.iizigo.navigator".
createFilteredCommonViewer
Creates the Filtered CommonViewer with extra support for Drag-and-Drop. The Tree Control gets an added focus listener to this instance as well as the viewer getting a post-selection listener.The tree is created with SWT.MULTI style.
- Parameters:
parent
- The parent.filter
- Filter.- Returns:
- The common viewer registered as "com.iizigo.navigator".
createFilteredCommonViewer
public final FilteredCommonViewer createFilteredCommonViewer(Composite parent, int style, IzFilter filter) Creates the Filtered CommonViewer with extra support for Drag-and-Drop. The Tree Control gets an added focus listener to this instance as well as the viewer getting a post-selection listener.- Parameters:
parent
- The parent.style
- Tree SWT styles.filter
- Filter.- Returns:
- The common viewer registered as "com.iizigo.navigator".
onDragBegin
protected void onDragBegin()Drag started.onDragEnd
protected void onDragEnd()Drag finished.isDragging
public boolean isDragging()Flag for dragging to postpone selection events until drag completes.- Specified by:
isDragging
in interfaceIDraggingFix
createMenu
Creates a menu that is used as a pop-up menu.createMenu
Creates a menu that is used as a pop-up menu.setFocus
public final void setFocus()Sets focus to the Editor. Subclasses should extend this method.- Specified by:
setFocus
in interfaceIWorkbenchPart
- Specified by:
setFocus
in classWorkbenchPart
onSetFocus
protected void onSetFocus()Called when set focus is called to override default processing. Override this method instead of the "final" setFocus method that can't be overridden (due to process of initialization errors, PartInitException, etc).registerViewer
Registers a viewer for selection changes. This will cause a focus listener to this class as well as a post-selection-listener. This method is required to set fulfill the contract of the editor's SelectionProvider contract.- Parameters:
viewer
- The viewer.index
- The control index.
registerViewer
Registers a viewer for selection changes. This will cause a focus listener to this class as well as a post-selection-listener. This method is required to set fulfill the contract of the editor's SelectionProvider contract.- Parameters:
viewer
- The viewer.index
- The control index.contributor
- The context menu contributor, null for none.
setTargetViewer
Sets the target viewer for e.g. add operations in order to make selection of the added properties at add, undo or redo.- Specified by:
setTargetViewer
in interfaceIPropUndoRedo
- Parameters:
viewer
- The CommonViewer, TreeViewer or TableViewer, or null for none.
getTargetViewer
Gets the structured viewer (common, tree or table) used for the property operation (add, delete, etc).- Specified by:
getTargetViewer
in interfaceIPropUndoRedo
- Returns:
- The CommonViewer, TreeViewer or TableViewer, or null for none.
setBlockViewerFocus
public void setBlockViewerFocus(boolean block) Blocks the target viewer from focus.- Specified by:
setBlockViewerFocus
in interfaceIPropertyEditorController
onComponentFocus
Called by the workbench extension when focus is received.gotoMarker
Sets the cursor and selection state for an editor to reveal the position of the given marker.- Specified by:
gotoMarker
in interfaceIGotoMarker
- Parameters:
marker
- the marker
setFocus
protected int setFocus(PropCnr container, StructuredViewer viewer, IzFilter filter, PropertyEditor propertyEditor, GProp<?> property, int index, String childName) Attempts to set focus to the property in question based on a container, a viewer and a property editor. If successful, the viewer selects the property or its ancestor, the property editor has the focus to the edited property.This call should be made from the SWT thread.
- Parameters:
container
- The container.viewer
- A viewer.filter
- A filter instance for the viewer, null for none.propertyEditor
- The property editor.property
- The property to focus.index
- Index in multi-property, -1 for none.childName
- Name of child property or null.- Returns:
- -1=failed, 0=selection only, 1=selection+property.