Package com.iizigo.vs.prop

Class VirtualSpaceDesignerProp

java.lang.Object
com.iizigo.prop.DesignerProp
com.iizigo.vs.prop.VirtualSpaceDesignerProp
All Implemented Interfaces:
INavigatorPresentation, EventListener, org.eclipse.core.runtime.IAdaptable
public class VirtualSpaceDesignerProp extends DesignerProp
Class for the EditorScreenProp in the designer.
Author:
Christopher Mindus

  • Constructor Details

    • VirtualSpaceDesignerProp

      public VirtualSpaceDesignerProp(PropCnr propertyContainer)
      The constructor.
      Parameters:
      propertyContainer -

  • Method Details

    • getVirtualSpaceProp

      public EditorVirtualSpace getVirtualSpaceProp()
      For any designer, get the VirtualSpace property.
      Returns:
      The EditorVirtualSpace instance, never null.

    • getPropertyEditorSetup

      protected PropertyEditorSetup getPropertyEditorSetup()
      Gets the Setup used for iiziGo, subclasses must override and provide their instance.
      Overrides:
      getPropertyEditorSetup in class DesignerProp

    • isCNVisible

      public boolean isCNVisible(int flags)
      Visibility: hide participants container.
      Overrides:
      isCNVisible in class DesignerProp
      Parameters:
      flags - The flags: FLAG_PACKAGE_VIEW, FLAG_SHOW_EMPTY_MAIN_FOLDER, FLAG_SHOW_EMPTY_PACKAGES, FLAG_SHOW_FILE_ITEMS, FLAG_SHOW_DESIGNER_PROPERTIES and FLAG_SHOW_SUBPROPERTIES are relevant.
      Returns:
      true Default is always true.

    • getCNRealProp

      public DesignerProp getCNRealProp()
      Gets the "real" property when the DesignerProp has been retrieved from e.g. the ContentProvider at add/remove events. The property parent might not be the same as the DesignerProp.
      Overrides:
      getCNRealProp in class DesignerProp
      Returns:
      By default, it is the "this" instance, but e.g. EditorVSRow for tables overrides it and returns the parent DesignerProp instead.

    • getCNParent

      public Object getCNParent(int flags)
      Gets the parent for Common Navigator.
      Specified by:
      getCNParent in interface INavigatorPresentation
      Overrides:
      getCNParent in class DesignerProp
      Parameters:
      flags - The flag that apply is FLAG_PACKAGE_VIEW.
      Returns:
      The parent object: IProject or DesignerProp, or null if no parent exists (property is not added to a container).

    • hasCNChildren

      public boolean hasCNChildren(int flags)
      Checks if there are children in this container for Common Navigator.
      Specified by:
      hasCNChildren in interface INavigatorPresentation
      Overrides:
      hasCNChildren in class DesignerProp
      Parameters:
      flags - The flags: FLAG_PACKAGE_VIEW, FLAG_SHOW_EMPTY_MAIN_FOLDER, FLAG_SHOW_EMPTY_PACKAGES, FLAG_SHOW_FILE_ITEMS, FLAG_SHOW_DESIGNER_PROPERTIES and FLAG_SHOW_SUBPROPERTIES are relevant.
      Returns:
      true if the node has children, and false if it has no children.

    • getCNChildren

      public Object[] getCNChildren(int flags)
      Gets the children of this container for Common Navigator.
      Specified by:
      getCNChildren in interface INavigatorPresentation
      Overrides:
      getCNChildren in class DesignerProp
      Parameters:
      flags - The flags: FLAG_PACKAGE_VIEW, FLAG_SHOW_EMPTY_MAIN_FOLDER, FLAG_SHOW_EMPTY_PACKAGES, FLAG_SHOW_FILE_ITEMS, FLAG_SHOW_DESIGNER_PROPERTIES and FLAG_SHOW_SUBPROPERTIES are relevant.
      Returns:
      An array of children objects or EMPTY_ARRAY for none.

    • getCNImage

      public org.eclipse.swt.graphics.Image getCNImage(int flags)
      Gets the image for the Common Navigator.
      Specified by:
      getCNImage in interface INavigatorPresentation
      Overrides:
      getCNImage in class DesignerProp
      Parameters:
      flags - The flags for the image, see FLAG_IMAGE_*.
      Returns:
      Image or null if there is no image.

    • getCNCategory

      public int getCNCategory()
      Gets the category of this Common Navigator object, used for sorting.
      Specified by:
      getCNCategory in interface INavigatorPresentation
      Overrides:
      getCNCategory in class DesignerProp
      Returns:
      Category for VirtualSpace, otherwise zero.

    • getCNText

      public String getCNText(int flags)
      Gets the label text for the Common Navigator.
      Specified by:
      getCNText in interface INavigatorPresentation
      Overrides:
      getCNText in class DesignerProp
      Returns:
      String or or null if there is no text.

    • getCNText

      public String getCNText(int columnIndex, int flags)
      Gets the text for columns.
      Specified by:
      getCNText in interface INavigatorPresentation
      Overrides:
      getCNText in class DesignerProp
      Parameters:
      columnIndex - The zero-based index for the column (zero is never used, the method getCNText() is called instead.
      Returns:
      String or or null if there is no text for the given object at columnIndex.

    • getCNDescriptionType

      public String getCNDescriptionType()
      Provide a type description for the status bar view, if available.
      Overrides:
      getCNDescriptionType in class DesignerProp
      Returns:
      A type description for the status bar view, or null if not available.

    • getCNComparator

      public IViewerComparator getCNComparator()
      Gets the comparator. For table, no sorting is done. This will keep Rows and Headers in correct ordering.
      Specified by:
      getCNComparator in interface INavigatorPresentation
      Overrides:
      getCNComparator in class DesignerProp
      Returns:
      The default comparator. Subclasses can inhibit sorting by returning null.

    • hasCNToolTip

      public boolean hasCNToolTip(org.eclipse.jface.viewers.ViewerCell cell)
      Checks for Common Navigator tool-tip for this item.
      Overrides:
      hasCNToolTip in class DesignerProp
      Parameters:
      cell - The cell (might be in a table), or null for none.

    • createCNToolTip

      public org.eclipse.swt.widgets.Composite createCNToolTip(org.eclipse.swt.widgets.Event event, org.eclipse.jface.viewers.ViewerCell cell, org.eclipse.swt.widgets.Composite parent)
      Requests creates of the Composite used to show the tooltip.
      Overrides:
      createCNToolTip in class DesignerProp
      Parameters:
      event - Event triggering the tooltip (mouse hover).
      cell - The cell (might be in a table).
      parent - The parent composite.
      Returns:
      The created composite in the parent.

    • canPerform

      public String canPerform(int operation)
      Checks if an operation on this property is permitted. Subclasses can override this method and return an error message, the default is to return null.

      Overridden for Web Service: delete/move not possible for Input/Output, link supported for Input/Output and Input Parameters.

      Overrides:
      canPerform in class DesignerProp
      Parameters:
      operation - The operation: OP_MOVE or OP_DELETE.
      Returns:
      null for OK, otherwise an error message.

    • isCNVisible0

      public boolean isCNVisible0(GProp<?> property, int flags)
      Checks if a property should be included in the view or if it's hidden or filtered out.
      Overrides:
      isCNVisible0 in class DesignerProp
      Parameters:
      property - The property in question.
      flags - The flags: FLAG_PACKAGE_VIEW, FLAG_SHOW_EMPTY_MAIN_FOLDER, FLAG_SHOW_EMPTY_PACKAGES, FLAG_SHOW_FILE_ITEMS, FLAG_SHOW_DESIGNER_PROPERTIES and FLAG_SHOW_SUBPROPERTIES are relevant.
      Returns:
      true Default is always true.

    • getCNText0

      protected String getCNText0(GProp<?> property, int flags)
      Gets the text for a sub-property for the Common Navigator.
      Overrides:
      getCNText0 in class DesignerProp

    • getCNText0

      protected String getCNText0(GProp<?> property, int columnIndex, int flags)
      Gets the text for a sub-property for the Common Navigator.
      Overrides:
      getCNText0 in class DesignerProp

    • getCNForeground0

      protected org.eclipse.swt.graphics.Color getCNForeground0(GProp<?> property, int columnIndex, int flags)
      Provides a foreground color for the given element.
      Overrides:
      getCNForeground0 in class DesignerProp

    • getCNBackground0

      protected org.eclipse.swt.graphics.Color getCNBackground0(GProp<?> property, int columnIndex, int flags)
      Provides a background color for the given element at the specified index.
      Overrides:
      getCNBackground0 in class DesignerProp

    • paste

      public PasteFeedback paste(boolean doPerformPaste, int position, GProp<?>[] props, int operation, String description, IPropUndoRedo undoRedo)
      Validates or performs a paste operation. The paste can be a move operation.
      Overrides:
      paste in class DesignerProp
      Parameters:
      doPerformPaste - Flag indication operation is to be performed (true) or just tested for validity (false).
      position - Position for paste: -1=before target, 0=in target, 1=after target.
      props - The properties.
      operation - The operation: OP_COPY or OP_MOVE.
      description - The description of the operation "source" for undo history.
      undoRedo - The undo/redo interface.
      Returns:
      The feed-back instance.