Package com.iizigo.link.ui

Class UIBuilderSubOperation

java.lang.Object
org.eclipse.jface.dialogs.DialogPage
org.eclipse.jface.wizard.WizardPage
com.iizigo.link.ui.UIBuilderSubOperation
All Implemented Interfaces:
ILinkOperation, ILinkWizardPage, org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.dialogs.IMessageProvider, org.eclipse.jface.wizard.IWizardPage
Direct Known Subclasses:
VSActionBuilderSubOp, VSFieldBuilderSubOp
public abstract class UIBuilderSubOperation extends org.eclipse.jface.wizard.WizardPage implements ILinkOperation, ILinkWizardPage
The UI build link operation that extends the normal link operation with information about the source so that they can be grouped.
Author:
Christopher Mindus

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final ApplicationUI
    appUI
    The Application UI.
    protected final IEUIContainer
    container
    The source container.
    protected org.eclipse.swt.widgets.Control
    lastFocused
    The last focused control.
    protected final org.eclipse.core.runtime.IAdaptable
    source
    The source being built.

    Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider

    ERROR, INFORMATION, NONE, WARNING

  • Constructor Summary

    Constructors
    Constructor
    Description
    UIBuilderSubOperation(String pageID, IEUIContainer container, org.eclipse.core.runtime.IAdaptable source)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addPages(LinkWizard wizard)
    Called when the wizard is created and allows the creation of additional wizard pages required.
    final boolean
    equalsOp(ILinkOperation op)
    Checks if two operations are equal.
    abstract String
    getBuilderComponent()
    Returns the builder component processed.
    abstract org.eclipse.swt.graphics.Image
    getBuilderImage()
    Returns the builder component image.
    abstract String
    getCommonDescription()
    The description of the common operation that is displayed on top of the wizard page.
    abstract String
    getCommonTitle()
    Returns the title of the common operation.
    abstract org.eclipse.jface.resource.ImageDescriptor
    getLargeImage()
    The large image descriptor for the operation, e.g.
    final ILinkOperation
    getLinkOperation()
    Returns the link operation for the page.
    EditorVirtualSpace
    getRequiredVirtualSpace()
    Returns the required VirtualSpace to be connected.
    abstract org.eclipse.swt.graphics.Image
    getTreeImage()
    The image for the operation in the tree on the first wizard page.
    UIBuildData
    getUIBuildData()
    Gets the build data.
    final org.eclipse.core.runtime.IStatus
    isOperationEnabled()
    Returns if the operation is enabled for execution, regardless of any preconditions.
    boolean
    isPageComplete()
    Page is complete if not selected, even if added.
    final boolean
    isPrecondition()
    Returns if the operation is a precondition required to run BEFORE the parent operation runs, or if it should be run AFTERWARDS.
    final boolean
    isSelected()
    Returns if this operation is selected or not.
    protected void
    setControl(org.eclipse.swt.widgets.Control newControl)
    Sets the control.
    void
    setVisible(boolean visible)
    Set focus to name at show.

    Methods inherited from class org.eclipse.jface.wizard.WizardPage

    canFlipToNextPage, getContainer, getDialogSettings, getImage, getName, getNextPage, getPreviousPage, getShell, getWizard, isCurrentPage, setDescription, setErrorMessage, setImageDescriptor, setMessage, setPageComplete, setPreviousPage, setTitle, setWizard, toString

    Methods inherited from class org.eclipse.jface.dialogs.DialogPage

    convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, dispose, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getMessage, getMessageType, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, performHelp, setButtonLayoutData, setMessage

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage

    createControl, dispose, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle

    Methods inherited from interface com.iizigo.link.ILinkOperation

    createOperationNode, executeOperation, getDependentOperations, isOperationEnabled, isWizardDialogRequired, validateOperations

    Methods inherited from interface org.eclipse.jface.wizard.IWizardPage

    canFlipToNextPage, getName, getNextPage, getPreviousPage, getWizard, setPreviousPage, setWizard

  • Field Details

    • appUI

      protected final ApplicationUI appUI
      The Application UI.

    • container

      protected final IEUIContainer container
      The source container.

    • source

      protected final org.eclipse.core.runtime.IAdaptable source
      The source being built.

    • lastFocused

      protected org.eclipse.swt.widgets.Control lastFocused
      The last focused control.

  • Constructor Details

    • UIBuilderSubOperation

      public UIBuilderSubOperation(String pageID, IEUIContainer container, org.eclipse.core.runtime.IAdaptable source)
      Constructor.
      Parameters:
      pageID - The page ID.
      container - The container.
      source - The source component being built.

  • Method Details

    • getUIBuildData

      public UIBuildData getUIBuildData()
      Gets the build data.

    • getLinkOperation

      public final ILinkOperation getLinkOperation()
      Returns the link operation for the page. Several pages may be present for an operation.
      Specified by:
      getLinkOperation in interface ILinkWizardPage
      Returns:
      The link operation of the page.

    • getRequiredVirtualSpace

      public EditorVirtualSpace getRequiredVirtualSpace()
      Returns the required VirtualSpace to be connected.
      Returns:
      The VirtualSpace required, or null for not required.

    • isSelected

      public final boolean isSelected()
      Returns if this operation is selected or not.

      This method is used e.g. in the build operations where a page shouldn't be displayed if the build wizard is not selected.

      Specified by:
      isSelected in interface ILinkOperation
      Returns:
      true if build wizard is selected, false otherwise.

    • isPrecondition

      public final boolean isPrecondition()
      Returns if the operation is a precondition required to run BEFORE the parent operation runs, or if it should be run AFTERWARDS.
      Specified by:
      isPrecondition in interface ILinkOperation
      Returns:
      true to run BEFORE, false to run AFTERWARDS.

    • isOperationEnabled

      public final org.eclipse.core.runtime.IStatus isOperationEnabled()
      Returns if the operation is enabled for execution, regardless of any preconditions. These are tested once all parties have agreed that the operation might be a "go".
      Specified by:
      isOperationEnabled in interface ILinkOperation
      Returns:
      The status for the operation.

    • equalsOp

      public final boolean equalsOp(ILinkOperation op)
      Checks if two operations are equal.
      Specified by:
      equalsOp in interface ILinkOperation
      Parameters:
      op - Operation to compare with.
      Returns:
      true if they produce the same result, false otherwise.

    • getCommonTitle

      public abstract String getCommonTitle()
      Returns the title of the common operation.

    • getCommonDescription

      public abstract String getCommonDescription()
      The description of the common operation that is displayed on top of the wizard page.

    • getTreeImage

      public abstract org.eclipse.swt.graphics.Image getTreeImage()
      The image for the operation in the tree on the first wizard page.

    • getLargeImage

      public abstract org.eclipse.jface.resource.ImageDescriptor getLargeImage()
      The large image descriptor for the operation, e.g. an Action, Field, etc.

    • getBuilderComponent

      public abstract String getBuilderComponent()
      Returns the builder component processed.

    • getBuilderImage

      public abstract org.eclipse.swt.graphics.Image getBuilderImage()
      Returns the builder component image.

    • addPages

      public void addPages(LinkWizard wizard)
      Called when the wizard is created and allows the creation of additional wizard pages required. All created pages MUST implement done to get the link wizard information.
      Specified by:
      addPages in interface ILinkOperation

    • setVisible

      public void setVisible(boolean visible)
      Set focus to name at show.
      Specified by:
      setVisible in interface org.eclipse.jface.dialogs.IDialogPage
      Overrides:
      setVisible in class org.eclipse.jface.dialogs.DialogPage

    • setControl

      protected void setControl(org.eclipse.swt.widgets.Control newControl)
      Sets the control.
      Overrides:
      setControl in class org.eclipse.jface.dialogs.DialogPage

    • isPageComplete

      public boolean isPageComplete()
      Page is complete if not selected, even if added.
      Specified by:
      isPageComplete in interface org.eclipse.jface.wizard.IWizardPage
      Overrides:
      isPageComplete in class org.eclipse.jface.wizard.WizardPage