Class NewVSComponentWizard<TYPE extends VSComponent>

Method Details

• newVSActionWizard

  public static NewVSComponentWizard<EditorVSAction> newVSActionWizard(EditorVirtualSpace virtualSpace, IPropUndoRedo undoRedo)

  Create a new instance of the wizard to create an action.

  Parameters:

  virtualSpace - The VirtualSpace.

  undoRedo - Undo/redo instance.

  Returns:

  The new component wizard.

• newVSTableWizard

  public static NewVSComponentWizard<EditorVSTable> newVSTableWizard(EditorVirtualSpace virtualSpace, VSReferenceOwnerData<VSTable,VSTableReference> tableOwner, IPropUndoRedo undoRedo)

  Create a new instance of the wizard to create a table.

  Parameters:

  virtualSpace - The VirtualSpace.

  tableOwner - The table owner, when possible to create table for a column that doesn't exist.

  undoRedo - Undo/redo instance.

  Returns:

  The new component wizard.

• newVSFieldWizard

  public static NewVSComponentWizard<EditorVSField> newVSFieldWizard(EditorVirtualSpace virtualSpace, Value.Type type, boolean isChooseTypeAllowed, Boolean isNullAllowed, boolean doCreateDefaultValue, IPropUndoRedo undoRedo)

  Create a new instance of the wizard to create a field.

  Parameters:

  virtualSpace - The VirtualSpace.

  type - Value type for column & field.

  isChooseTypeAllowed - Flag indicating user is allowed to choose type (for field and column).

  isNullAllowed - Flag to allow null for column & field, specify null to let user choose.

  doCreateDefaultValue - Flag to create a default value, event when null is allowed or chosen.

  undoRedo - Undo/redo instance.

  Returns:

  The new component wizard.

• newVSTableColumnWizard

  public static NewVSComponentWizard<EditorVSColumnHeader> newVSTableColumnWizard(EditorVirtualSpace virtualSpace, Value.Type type, boolean isChooseTypeAllowed, Boolean isNullAllowed, boolean doCreateDefaultValue, VSReferenceOwnerData<VSTable,VSTableReference> tableOwner, IPropUndoRedo undoRedo)

  Create a new instance of the wizard to create a field or a table column.

  Parameters:

  virtualSpace - The VirtualSpace.

  type - Value type for column & field.

  isChooseTypeAllowed - Flag indicating user is allowed to choose type (for field and column).

  isNullAllowed - Flag to allow null for column & field, specify null to let user choose.

  doCreateDefaultValue - Flag to create a default value, event when null is allowed or chosen.

  tableOwner - The table owner, when possible to create table for a column that doesn't exist.

  undoRedo - Undo/redo instance.

  Returns:

  The new component wizard.

• createPageControls

  public void createPageControls(Composite pageContainer)

  Creation: override to set image on shell.

  Specified by:

  createPageControls in interface IWizard

  Overrides:

  createPageControls in class Wizard

• performFinish

  public boolean performFinish()

  Finishes the wizard.

  Specified by:

  performFinish in interface IWizard

  Specified by:

  performFinish in class Wizard

• getComponent

  public TYPE getComponent()

  Gets the created component.

• getVirtualSpace

  public EditorVirtualSpace getVirtualSpace()

  Returns the VirtualSpace.

  Specified by:

  getVirtualSpace in interface INewVSComponentWizardInfo

• getValueType

  public Value.Type getValueType()

  Returns the value type where this applies (for VS Field and VS Column Header).

  Specified by:

  getValueType in interface INewVSComponentWizardInfo

• setValueType

  public void setValueType(Value.Type valueType)

  Sets the value type where this applies (for VS Field and VS Column Header).

  Specified by:

  setValueType in interface INewVSComponentWizardInfo

  Parameters:

  valueType - The new value type.

• isChooseTypeAllowed

  public boolean isChooseTypeAllowed()

  Returns if the user is allowed to choose type.

  Specified by:

  isChooseTypeAllowed in interface INewVSComponentWizardInfo

• isNullAllowed

  public Boolean isNullAllowed()

  Returns if null is allowed.

  Specified by:

  isNullAllowed in interface INewVSComponentWizardInfo

  Returns:

  null to enable user to choose, otherwise Boolean.TRUE or Boolean.FALSE to disable user choice and use this setting.

• setNullAllowed

  public void setNullAllowed(boolean isNullAllowed)

  Sets the null allowed flag.

  Specified by:

  setNullAllowed in interface INewVSComponentWizardInfo

• doCreateDefaultValue

  public boolean doCreateDefaultValue()

  Returns if a default value should be created.

  Specified by:

  doCreateDefaultValue in interface INewVSComponentWizardInfo

• getTableOwner

  public VSReferenceOwnerData<VSTable,VSTableReference> getTableOwner()

  Gets the table owner, for table column creation.

  Specified by:

  getTableOwner in interface INewVSComponentWizardInfo

  Returns:

  The table owner, or null for not available (or not applicable).

• getUndoRedo

  public IPropUndoRedo getUndoRedo()

  Gets the undo/redo instance.

  Specified by:

  getUndoRedo in interface INewVSComponentWizardInfo

• getRequestedName

  public String getRequestedName()

  Gets the requested name.

  Specified by:

  getRequestedName in interface INewVSComponentWizardInfo

  Returns:

  null if no name is requested.

• setRequestedName

  public void setRequestedName(String requestedName)

  Sets the requested name.

  Specified by:

  setRequestedName in interface INewVSComponentWizardInfo

  Parameters:

  requestedName - null if no name is requested.