Class EditorInfoPropCnr

All Implemented Interfaces:
IPropDesigner, ITooltipPropList, IVirtualizedMonitorPanelProvider, IVirtualizedMonitorProp, EventListener, IGProp<GProp<?>[]>, IPropCnr, Cloneable, org.eclipse.core.runtime.IAdaptable
Direct Known Subclasses:
EditorActiveTerminalSessions, EditorClientSessionProp, EditorEndPointPropCnr, EditorEndPointsPropCnr, EditorSessionConnectionStatProp

public abstract class EditorInfoPropCnr extends PropCnr implements IVirtualizedMonitorProp, IVirtualizedMonitorPanelProvider
Property container used to transport information, typically between server and monitor, where the information typically is a "snapshot" of properties. The Designer version of this instance can interact with Eclipse UI.
Christopher Mindus
  • Field Details

    • items

      protected String[] items
      Definition of items, null for automatic.
    • headers

      protected String[] headers
      Definition of headers, null for automatic.
    • map

      protected HashMap<String,String> map
      Map of property names (as key) to headers (as value), null for none.
    • formatMap

      protected HashMap<String,ITooltipStringFormatter> formatMap
      Map of property names (as key) to formatter (as value), null for none.
  • Constructor Details

    • EditorInfoPropCnr

      public EditorInfoPropCnr()
      Constructs the instance from the framework.
  • Method Details

    • getDesigner

      public VirtualizedMonitorDesignerProp getDesigner()
      Gets the Designer Extension for Properties.
      Specified by:
      getDesigner in interface IPropDesigner
      Specified by:
      getDesigner in interface IVirtualizedMonitorProp
      The instance of the Designer Extension.
    • clone

      public EditorInfoPropCnr clone()
      Clones the instance.
      clone in class PropCnr
    • getTooltipPropertyList

      public List<TooltipItem> getTooltipPropertyList()
      Gets the list of property names that should be displayed. The value is a String with a Tab delimiter for the text prompt, i.e. an item "Text prompt\t$text" will take a property named "$text" shown with the text prompt "Text prompt:". The first item indicates the heading. Special values for an item are:
      • "" (only empty string) will add space before next line (4 pixel per empty string),
      • "-" for a separator line,
      • "MMM\t" for full line width of text "MMM",
      • "$" for the property name,
      • "&cnText" for the text.
      • "&cnDescription" for the property getCNDescription() available on Text prompt side (before \t),
      • "&cnDescriptionType" for the property getCNDescriptionType() available on Text prompt side (before \t).
      An item that is preceeded with "#" will use bold font.
      An item that is preceeded with "%" will use bold font and the image for the property.
      Specified by:
      getTooltipPropertyList in interface ITooltipPropList
      The list, or null for no tooltip.
    • getCNCategory

      public int getCNCategory()
      Gets the category of this Common Navigator object, used for sorting.
      Specified by:
      getCNCategory in interface IVirtualizedMonitorProp
      This method returns zero, i.e. no category.
    • getCNImage

      public getCNImage()
      Gets the image for the Common Navigator.
      Specified by:
      getCNImage in interface IVirtualizedMonitorProp
      Image or null if there is no image.
    • getCNText

      public String getCNText()
      Gets the label text for the Common Navigator.
      Specified by:
      getCNText in interface IVirtualizedMonitorProp
    • getCNDescriptionType

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

      public boolean canEditProperties()
      Returns if the properties should be shown in the property editor.
      Specified by:
      canEditProperties in interface IVirtualizedMonitorPanelProvider
      true by default.
    • canShowPanelPart

      public boolean canShowPanelPart()
      Returns if the right panel part can be shown.
      Specified by:
      canShowPanelPart in interface IVirtualizedMonitorPanelProvider
      false by default, override to handle panel parts.
    • showPanelPart

      public void showPanelPart(org.eclipse.swt.widgets.Composite parent)
      Requests to show the panel part. When called, the composite is initialized to a grid layout of 1 column with standard margins.
      Specified by:
      showPanelPart in interface IVirtualizedMonitorPanelProvider
      parent - The parent composite.