Class EUIComps

All Implemented Interfaces:
ILinkCapable, IUIBuilderFromVSLinkEnabler, IEUICompBase, IExtendsSelection, IPropDesigner, ITooltipPropList, EventListener, IGProp<GProp<?>[]>, IPropCnr, Cloneable, org.eclipse.core.runtime.IAdaptable

Editor class for UIComps.
Author:
Christopher Mindus
  • Constructor Details

    • EUIComps

      public EUIComps()
      Creates the property container without a name. The name must be set in all cases using the setPropertyAtom call.
    • EUIComps

      public EUIComps(Atom propertyAtom)
      Creates the property container with the specified name. All system-reserved names for components begins with "$".
      Parameters:
      propertyAtom - the name of the component, unique within it's parent.
  • Method Details

    • getDesigner

      public UICompsDesignerProp getDesigner()
      Gets the Designer Extension for Properties.
      Specified by:
      getDesigner in interface IPropDesigner
      Returns:
      The instance of the Designer Extension.
    • getCNImage

      public org.eclipse.swt.graphics.Image getCNImage(boolean isMobile)
      Gets the image for the Common Navigator.
      Specified by:
      getCNImage in interface IEUICompBase
      Parameters:
      isMobile - The mobile theme flag.
      Returns:
      Image or null if there is no image.
    • getCNDescriptionType

      public String getCNDescriptionType()
      Provide a type description for the status bar view, if available.
      Specified by:
      getCNDescriptionType in interface IEUICompBase
      Returns:
      A type description for the status bar view, or null if not available.
    • clone

      public EUIComps clone()
      Clone must be overridden.
      Overrides:
      clone in class UIComps
    • getTooltipPropertyList

      public List<TooltipItem> getTooltipPropertyList()
      Gets the list of property names that should be displayed.
      Specified by:
      getTooltipPropertyList in interface ITooltipPropList
      Returns:
      The list, or null for no tooltip.
    • getPossibleChildren

      public Class<?>[] getPossibleChildren()
      Gets the acceptable children property classes that can be used in conjunction with e.g. a Paste operation.
      Specified by:
      getPossibleChildren in interface IPropCnr
      Overrides:
      getPossibleChildren in class PropCnr
      Returns:
      An array containing the classes of possible children, or null for no support.
    • validateClassInstances

      public boolean validateClassInstances(boolean doPerform, GProp<?>[] props, boolean isMove)
      Validates the target property container classes for paste/move with additional instance testing, extra check when the possible children are verified.

      Override this method that by default returns true to provide fine-tuned testing for validity.

      Specified by:
      validateClassInstances in interface IPropCnr
      Overrides:
      validateClassInstances in class PropCnr
      Parameters:
      doPerform - The perform flag, false means just testing.
      props - Properties to move or paste.
      isMove - Flag for move if true, false means paste.
      Returns:
      true if the class instances for move or paste are valid, false otherwise.
    • getExtendsPossibleClasses

      public Class<?>[] getExtendsPossibleClasses()
      Gets the possible classes this container supports for the Extends Framework. The default implementation is to return null.
      Specified by:
      getExtendsPossibleClasses in interface IPropCnr
      Overrides:
      getExtendsPossibleClasses in class PropCnr
      Returns:
      List of supported classes, or null for none.
    • getSelectPropDialogTitle

      public String getSelectPropDialogTitle()
      Gets the title for selection dialog.
      Specified by:
      getSelectPropDialogTitle in interface IExtendsSelection
    • getSelectPropViewerFilter

      public org.eclipse.jface.viewers.ViewerFilter getSelectPropViewerFilter()
      Gets the viewer filter for the tree in the dialog for selecting extends property name.
      Specified by:
      getSelectPropViewerFilter in interface IExtendsSelection