Class ServerConfigView

All Implemented Interfaces:
IActivationListener, IWorkbenchPartIZ, IDisposedPart, IAdaptable, IExecutableExtension, IPersistable, ISaveablePart, ISaveablePart2, IViewPart, IWorkbenchPart, IWorkbenchPart2, IWorkbenchPart3, IWorkbenchPartOrientation

public class ServerConfigView extends ViewPart implements IWorkbenchPartIZ, ISaveablePart2, IActivationListener
The Server Configuration View displays a tree with the server configuration and a property editor for the properties.
Author:
Christopher Mindus
  • Field Details

    • ID

      public static final String ID
      The View Part ID.
  • Constructor Details

    • ServerConfigView

      public ServerConfigView()
      Creates the folder view.
  • Method Details

    • openFile

      public static ServerConfigView openFile(String fileName, boolean doUpdateHistory)
      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(IViewSite site, IMemento memento) throws 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:
      init in interface IViewPart
      Overrides:
      init in class ViewPart
      Throws:
      PartInitException
    • saveState

      public void saveState(IMemento memento)
      Saves the state.
      Specified by:
      saveState in interface IPersistable
      Specified by:
      saveState in interface IViewPart
      Overrides:
      saveState in class ViewPart
    • createPartControl

      public void createPartControl(Composite parent)
      Creates the view part.
      Specified by:
      createPartControl in interface IWorkbenchPart
      Specified by:
      createPartControl in class 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:
      dispose in interface IWorkbenchPart
      Overrides:
      dispose in class WorkbenchPart
    • setFocus

      public void setFocus()
      Focus to best component, where the framework takes care of it normally.
      Specified by:
      setFocus in interface IWorkbenchPart
      Specified by:
      setFocus in class WorkbenchPart
    • getExtension

      public IPartExtensionIZ getExtension()
      Gets the extensions framework.
      Specified by:
      getExtension in interface IWorkbenchPartIZ
    • getUndoRedo

      public IPropUndoRedo getUndoRedo()
      Gets the undo/redo instance.
      Specified by:
      getUndoRedo in interface IWorkbenchPartIZ
    • isDisposed

      public boolean isDisposed()
      Checks if the part is disposed of.
      Specified by:
      isDisposed in interface IActivationListener
      Specified by:
      isDisposed in interface IDisposedPart
      Specified by:
      isDisposed in interface IWorkbenchPartIZ
      Returns:
      true if disposed of, false otherwise.
    • getSelectionEnabler

      public SelectionEnabler getSelectionEnabler()
      Gets the selection enabler instance.
      Specified by:
      getSelectionEnabler in interface IWorkbenchPartIZ
    • 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:
      promptToSaveOnClose in interface ISaveablePart2
      Returns:
      the return code, must be either YES, NO, CANCEL or DEFAULT.
    • doSave

      public void doSave(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_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.

      This method is long-running; progress and cancellation are provided by the given progress monitor.

      Specified by:
      doSave in interface 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 IProgressMonitor should be used to indicate progress.

      If the save is successful, the part fires a property changed event reflecting the new dirty state (PROP_DIRTY property).

      Specified by:
      doSaveAs in interface 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 with PROP_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:
      isDirty in interface ISaveablePart
      Returns:
      true if the contents have been modified and need saving, and false if 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:
      isSaveAsAllowed in interface ISaveablePart
      Returns:
      true if "Save As" is supported, and false if not supported
    • isSaveOnCloseNeeded

      public boolean isSaveOnCloseNeeded()
      Returns whether the contents of this part should be saved when the part is closed.
      Specified by:
      isSaveOnCloseNeeded in interface ISaveablePart
      Returns:
      true if the contents of the part should be saved on close, and false if the contents are expendable
    • updateStates

      public void updateStates()
      Called when states needs to be updated.
      Specified by:
      updateStates in interface IActivationListener
    • onActivated

      public void onActivated(boolean on)
      Called when activator or deactivated.
      Specified by:
      onActivated in interface IActivationListener
    • onClose

      public void onClose()
      Called when about to close, but SWT is still there.
      Specified by:
      onClose in interface IActivationListener