Class ServerConfigView
- All Implemented Interfaces:
IActivationListener,IWorkbenchPartIZ,org.eclipse.core.runtime.IAdaptable,org.eclipse.core.runtime.IExecutableExtension,org.eclipse.ui.IPersistable,org.eclipse.ui.ISaveablePart,org.eclipse.ui.ISaveablePart2,org.eclipse.ui.IViewPart,org.eclipse.ui.IWorkbenchPart,org.eclipse.ui.IWorkbenchPart2,org.eclipse.ui.IWorkbenchPart3,org.eclipse.ui.part.IWorkbenchPartOrientation
- Author:
- Christopher Mindus
Field Summary
FieldsFields inherited from interface org.eclipse.ui.ISaveablePart
PROP_DIRTYFields inherited from interface org.eclipse.ui.ISaveablePart2
CANCEL, DEFAULT, NO, YESFields inherited from interface org.eclipse.ui.IWorkbenchPart
PROP_TITLEConstructor Summary
ConstructorsMethod Summary
Modifier and TypeMethodDescriptionvoidcreatePartControl(org.eclipse.swt.widgets.Composite parent) Creates the view part.voiddispose()Disposes of this workbench part.voiddoSave(org.eclipse.core.runtime.IProgressMonitor monitor) Saves the contents of this part.voiddoSaveAs()Saves the contents of this part to another object.Gets the extensions framework.Gets the selection enabler instance.Gets the undo/redo instance.voidinit(org.eclipse.ui.IViewSite site, org.eclipse.ui.IMemento memento) Initializes this view with the given view site.booleanisDirty()Returns whether the contents of this part have changed since the last save operation.booleanChecks if the part is disposed of.booleanReturns whether the "Save As" operation is supported by this part.booleanReturns whether the contents of this part should be saved when the part is closed.voidonActivated(boolean on) Called when activator or deactivated.voidonClose()Called when about to close, but SWT is still there.static ServerConfigViewOpen a view for a Server configuration file, or focuses an existing view for the file.intPrompts the user for input on what to do with unsaved data.voidsaveState(org.eclipse.ui.IMemento memento) Saves the state.voidsetFocus()Focus to best component, where the framework takes care of it normally.voidCalled when states needs to be updated.Methods inherited from class org.eclipse.ui.part.ViewPart
checkSite, getViewSite, init, setContentDescription, setInitializationData, setPartNameMethods inherited from class org.eclipse.ui.part.WorkbenchPart
addPartPropertyListener, addPropertyListener, firePartPropertyChanged, firePropertyChange, getAdapter, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, getTitleToolTip, removePartPropertyListener, removePropertyListener, setPartProperty, setSite, setTitle, setTitleImage, setTitleToolTip, showBusyMethods inherited from class org.eclipse.core.commands.common.EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObjectMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapterMethods inherited from interface org.eclipse.ui.IWorkbenchPart
addPropertyListener, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListenerMethods inherited from interface com.iizigo.editor.IWorkbenchPartIZ
onComponentFocused
Field Details
ID
The View Part ID.
Constructor Details
ServerConfigView
public ServerConfigView()Creates the folder view.
Method Details
openFile
Open a view for a Server configuration file, or focuses an existing view for the file.- Parameters:
fileName- The file name.doUpdateHistory- Flag to update history for last recently used file.- Returns:
- The Server Configuration view, or null if the file doesn't exist.
init
public void init(org.eclipse.ui.IViewSite site, org.eclipse.ui.IMemento memento) throws org.eclipse.ui.PartInitException Initializes this view with the given view site. A memento is passed to the view which contains a snapshot of the views state from a previous session. Where possible, the view should try to recreate that state within the part controls.This implementation will ignore the memento and initialize the view in a fresh state.
- Specified by:
initin interfaceorg.eclipse.ui.IViewPart- Overrides:
initin classorg.eclipse.ui.part.ViewPart- Throws:
org.eclipse.ui.PartInitException
saveState
public void saveState(org.eclipse.ui.IMemento memento) Saves the state.- Specified by:
saveStatein interfaceorg.eclipse.ui.IPersistable- Specified by:
saveStatein interfaceorg.eclipse.ui.IViewPart- Overrides:
saveStatein classorg.eclipse.ui.part.ViewPart
createPartControl
public void createPartControl(org.eclipse.swt.widgets.Composite parent) Creates the view part.- Specified by:
createPartControlin interfaceorg.eclipse.ui.IWorkbenchPart- Specified by:
createPartControlin classorg.eclipse.ui.part.WorkbenchPart
dispose
public void dispose()Disposes of this workbench part.This is the last method called on the IWorkbenchPart. At this point the part controls (if they were ever created) have been disposed as part of an SWT composite. There is no guarantee that createPartControl() has been called, so the part controls may never has been created.
Within this method a part may release any resources, fonts, images, etc. held by this part. It is also very important to de-register all listeners from the workbench.
- Specified by:
disposein interfaceorg.eclipse.ui.IWorkbenchPart- Overrides:
disposein classorg.eclipse.ui.part.WorkbenchPart
setFocus
public void setFocus()Focus to best component, where the framework takes care of it normally.- Specified by:
setFocusin interfaceorg.eclipse.ui.IWorkbenchPart- Specified by:
setFocusin classorg.eclipse.ui.part.WorkbenchPart
getExtension
Gets the extensions framework.- Specified by:
getExtensionin interfaceIWorkbenchPartIZ
getUndoRedo
Gets the undo/redo instance.- Specified by:
getUndoRedoin interfaceIWorkbenchPartIZ
isDisposed
public boolean isDisposed()Checks if the part is disposed of.- Specified by:
isDisposedin interfaceIActivationListener- Specified by:
isDisposedin interfaceIWorkbenchPartIZ- Returns:
- true if disposed of, false otherwise.
getSelectionEnabler
Gets the selection enabler instance.- Specified by:
getSelectionEnablerin interfaceIWorkbenchPartIZ
promptToSaveOnClose
public int promptToSaveOnClose()Prompts the user for input on what to do with unsaved data. This method is only called when the part is closed or when the Workbench is shutting down.- Specified by:
promptToSaveOnClosein interfaceorg.eclipse.ui.ISaveablePart2- Returns:
- the return code, must be either
YES,NO,CANCELorDEFAULT.
doSave
public void doSave(org.eclipse.core.runtime.IProgressMonitor monitor) 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_DIRTYproperty).If the save is cancelled through user action, or for any other reason, the part should invoke
setCancelledon theIProgressMonitorto inform the caller.This method is long-running; progress and cancellation are provided by the given progress monitor.
- Specified by:
doSavein interfaceorg.eclipse.ui.ISaveablePart- Parameters:
monitor- the progress monitor
doSaveAs
public void doSaveAs()Saves the contents of this part to another object.Implementors are expected to open a "Save As" dialog where the user will be able to select a new name for the contents. After the selection is made, the contents should be saved to that new name. During this operation a
IProgressMonitorshould be used to indicate progress.If the save is successful, the part fires a property changed event reflecting the new dirty state (
PROP_DIRTYproperty).- Specified by:
doSaveAsin interfaceorg.eclipse.ui.ISaveablePart
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 withPROP_DIRTY.Note: this method is called often on a part open or part activation switch, for example by actions to determine their enabled status.
- Specified by:
isDirtyin interfaceorg.eclipse.ui.ISaveablePart- Returns:
trueif the contents have been modified and need saving, andfalseif they have not changed since the last save
isSaveAsAllowed
public boolean isSaveAsAllowed()Returns whether the "Save As" operation is supported by this part.- Specified by:
isSaveAsAllowedin interfaceorg.eclipse.ui.ISaveablePart- Returns:
trueif "Save As" is supported, andfalseif not supported
isSaveOnCloseNeeded
public boolean isSaveOnCloseNeeded()Returns whether the contents of this part should be saved when the part is closed.- Specified by:
isSaveOnCloseNeededin interfaceorg.eclipse.ui.ISaveablePart- Returns:
trueif the contents of the part should be saved on close, andfalseif the contents are expendable
updateStates
public void updateStates()Called when states needs to be updated.- Specified by:
updateStatesin interfaceIActivationListener
onActivated
public void onActivated(boolean on) Called when activator or deactivated.- Specified by:
onActivatedin interfaceIActivationListener
onClose
public void onClose()Called when about to close, but SWT is still there.- Specified by:
onClosein interfaceIActivationListener