Package com.iizigo.prop.tooltip

Class TooltipItem

java.lang.Object
com.iizigo.prop.tooltip.TooltipItem
public class TooltipItem extends Object
Tooltip item class used to display a tooltip for a property container implementing the ITooltipPropList interface.

Flags are composed as F_* bit flag or'ed with the type of:

  • 0 = normal text
  • 1 = property value (perhaps using formatter)
  • 2 = property name getPropName()
  • 3 = getCNText()
  • 4 = getCNDescription()
  • 5 = getCNDescriptionType()
  • 14 = Vertical indent with "valueFlags" pixels
  • 15 = Horizontal line
Author:
Christopher Mindus

  • Field Details

    • F_IMAGE

      public static final int F_IMAGE
      Flag for Image.
      See Also:

    • F_BOLD

      public static final int F_BOLD
      Flag for bold font, cannot be combined with italic font.
      See Also:

    • F_ITALIC

      public static final int F_ITALIC
      Flag for italic font, cannot be combined with bold font.
      See Also:

    • T_NORMAL

      public static final int T_NORMAL
      Type: normal.
      See Also:

    • T_PROP_VALUE

      public static final int T_PROP_VALUE
      Type: property value (perhaps using formatter).
      See Also:

    • T_PROP_NAME

      public static final int T_PROP_NAME
      Type: property name.
      See Also:

    • T_CN_TEXT

      public static final int T_CN_TEXT
      Type: string as getCNText().
      See Also:

    • T_CN_DESCRIPTION

      public static final int T_CN_DESCRIPTION
      Type: string as getCNDescription().
      See Also:

    • T_CN_DESCRIPTION_TYPE

      public static final int T_CN_DESCRIPTION_TYPE
      Type: string as getCNDescriptionType().
      See Also:

    • T_CN_TYPE_DESCRIPTION_TYPE

      public static final int T_CN_TYPE_DESCRIPTION_TYPE
      Type: string as getCNTypeDescriptionType() when available (only for IPropDesigner implementing properties).
      See Also:

    • HEADER_DESCR_TYPE

      public static final TooltipItem HEADER_DESCR_TYPE
      Header line: BOLD + CNDescription + ':'.

    • HEADER_IMAGE_DESCR_TYPE

      public static final TooltipItem HEADER_IMAGE_DESCR_TYPE
      Header line: BOLD + Image + CNDescription + ':'.

    • HEADER_IMAGE_DESCR_TYPE_NAME

      public static final TooltipItem HEADER_IMAGE_DESCR_TYPE_NAME
      Header line: BOLD + Image + CNDescription + ':' + PropName.

    • HEADER_DESCR_TYPE_NAME

      public static final TooltipItem HEADER_DESCR_TYPE_NAME
      Header line: BOLD + CNDescription + ':' + PropName.

    • HEADER_DESCR_TEXT

      public static final TooltipItem HEADER_DESCR_TEXT
      Header line: BOLD + CNDescription + ':' + CNText.

    • SEPARATOR

      public static final TooltipItem SEPARATOR
      The horizontal separator line.

    • SPACER_4PX

      public static final TooltipItem SPACER_4PX
      The vertical indent of 4 pixels.

    • SPACER_8PX

      public static final TooltipItem SPACER_8PX
      The vertical indent of 8 pixels.

    • ATOM_HSCROLL

      public static final TooltipItem ATOM_HSCROLL
      A line for horizontal overflow for layouts, default value in italic.

    • ATOM_VSCROLL

      public static final TooltipItem ATOM_VSCROLL
      A line for horizontal overflow for layouts, default value in italic.

  • Method Details

    • newID

      public static TooltipItem newID(String prompt)
      Constructs a line with normal fonts of a text prompt and a property name "ID" (Atom).
      Parameters:
      prompt - The text prompt.
      Returns:
      A tooltip item.

    • newNormal

      public static TooltipItem newNormal(String prompt, String atomName)
      Constructs a line with normal fonts of a text prompt and a property atom.
      Parameters:
      prompt - The text prompt.
      atomName - The atom name.
      Returns:
      A tooltip item.

    • newNormal

      public static TooltipItem newNormal(String prompt, Atom atom)
      Constructs a line with normal fonts of a text prompt and a property atom.
      Parameters:
      prompt - The text prompt.
      atom - The atom name.
      Returns:
      A tooltip item.

    • newNormal

      public static TooltipItem newNormal(String prompt, Atom atom, ITooltipStringFormatter formatter)
      Constructs a line with normal fonts of a text prompt and a property atom with a formatter.
      Parameters:
      prompt - The text prompt.
      atom - The atom.
      formatter - The formatter of the item.
      Returns:
      A tooltip item.

    • newNormal

      public static TooltipItem newNormal(String prompt, String atomName, ITooltipStringFormatter formatter)
      Constructs a line with normal fonts of a text prompt and a property atom with a formatter.
      Parameters:
      prompt - The text prompt.
      atomName - The atom name.
      formatter - The formatter of the item.
      Returns:
      A tooltip item.

    • newIntItalic

      public static TooltipItem newIntItalic(String prompt, String atomName, int defaultValue)
      Constructs a line for an integer value, default shown in italic.
      Parameters:
      prompt - The text prompt.
      atomName - The atom name.
      Returns:
      A tooltip item.

    • newBool

      public static TooltipItem newBool(String prompt, String atomName)
      Constructs a line for a boolean value, not displayed if not defined.
      Parameters:
      prompt - The text prompt.
      atomName - The atom name.
      Returns:
      A tooltip item.

    • newBool

      public static TooltipItem newBool(String prompt, Atom atom)
      Constructs a line for a boolean value, not displayed if not defined.
      Parameters:
      prompt - The text prompt.
      atom - The atom.
      Returns:
      A tooltip item.

    • newBoolTrue

      public static TooltipItem newBoolTrue(String prompt, String atomName)
      Constructs a line for a boolean value with default value true.
      Parameters:
      prompt - The text prompt.
      atomName - The atom name.
      Returns:
      A tooltip item.

    • newBoolTrue

      public static TooltipItem newBoolTrue(String prompt, Atom atom)
      Constructs a line for a boolean value with default value true.
      Parameters:
      prompt - The text prompt.
      atom - The atom.
      Returns:
      A tooltip item.

    • newIntIndex

      public static TooltipItem newIntIndex(String prompt, String atomName, List<String> list, String defaultValue)
      Constructs a line with normal fonts of a text prompt and a property atom with a formatter.
      Parameters:
      prompt - The text prompt.
      atomName - The atom name.
      list - List containing zero-based values
      defaultValue - String value to show if value is undefined or out of range.
      Returns:
      A tooltip item.

    • newIntIndex

      public static TooltipItem newIntIndex(String prompt, String atomName, String[] array, String defaultValue)
      Constructs a line with normal fonts of a text prompt and a property atom with a formatter.
      Parameters:
      prompt - The text prompt.
      atomName - The atom name.
      array - Array containing zero-based values
      defaultValue - String value to show if value is undefined or out of range.
      Returns:
      A tooltip item.

    • newIntIndex

      public static TooltipItem newIntIndex(String prompt, String atomName, List<String> list)
      Constructs a line with normal fonts of a text prompt and a property atom with a formatter.
      Parameters:
      prompt - The text prompt.
      atomName - The atom name.
      array - Array containing zero-based values
      Returns:
      A tooltip item.

    • newIntIndex

      public static TooltipItem newIntIndex(String prompt, String atomName, String[] array)
      Constructs a line with normal fonts of a text prompt and a property atom with a formatter.
      Parameters:
      prompt - The text prompt.
      atomName - The atom name.
      list - List containing zero-based values
      Returns:
      A tooltip item.

    • newIntIndex

      public static TooltipItem newIntIndex(String prompt, Atom atomName, String[] array, String defaultValue)
      Constructs a line with normal fonts of a text prompt and a property atom with a formatter.
      Parameters:
      prompt - The text prompt.
      atomName - The atom name.
      array - Array containing zero-based values
      defaultValue - String value to show if value is undefined or out of range.
      Returns:
      A tooltip item.

    • newIntIndex

      public static TooltipItem newIntIndex(String prompt, Atom atomName, List<String> list)
      Constructs a line with normal fonts of a text prompt and a property atom with a formatter.
      Parameters:
      prompt - The text prompt.
      atomName - The atom name.
      list - Array containing zero-based values.
      Returns:
      A tooltip item.

    • newIntIndex

      public static TooltipItem newIntIndex(String prompt, Atom atomName, String[] array)
      Constructs a line with normal fonts of a text prompt and a property atom with a formatter.
      Parameters:
      prompt - The text prompt.
      atomName - The atom name.
      array - Array containing zero-based values.
      Returns:
      A tooltip item.

    • newNormal

      public static TooltipItem newNormal(String prompt, ITooltipStringFormatter formatter)
      Constructs a line with normal fonts of a text prompt and a formatter. Italic is used for the value if the string is empty, replacing the empty value string with "empty".
      Parameters:
      prompt - The text prompt.
      formatter - The formatter of the item.
      Returns:
      A tooltip item.

    • newNormalItalicEmpty

      public static TooltipItem newNormalItalicEmpty(String prompt, String atomName)
      Constructs a line with normal fonts of a text prompt and a property atom. Italic is used for the value if the string is empty, replacing the empty value string with "empty".
      Parameters:
      prompt - The text prompt.
      atomName - The atom name.
      Returns:
      A tooltip item.

    • newNormalItalicEmpty

      public static TooltipItem newNormalItalicEmpty(String prompt, Atom atom)
      Constructs a line with normal fonts of a text prompt and a property atom. Italic is used for the value if the string is empty, replacing the empty value string with "empty".
      Parameters:
      prompt - The text prompt.
      atom - The atom name.
      Returns:
      A tooltip item.

    • newNormalItalicEmpty

      public static TooltipItem newNormalItalicEmpty(String prompt, String atomName, ITooltipStringFormatter formatter)
      Constructs a line with normal fonts of a text prompt and a property atom with a formatter. Italic is used for the value if the string is empty, replacing the empty value string with "empty".
      Parameters:
      prompt - The text prompt.
      atomName - The atom name.
      formatter - The formatter of the item.
      Returns:
      A tooltip item.

    • wouldCreateLine

      public boolean wouldCreateLine(PropCnr pc)
      Checks if this item would produce a change in the parent composite or not.
      Parameters:
      pc - The property container.
      Returns:
      Flag indicating this would change the parent composite by adding tooltip info.

    • createLine

      public int createLine(Composite parent, PropCnr pc, int verticalIndent)
      Creates a line with the settings specified.
      Parameters:
      parent - The parent composite.
      pc - The property container.
      verticalIndent - The vertical indent, negative value indicates separator before.
      Returns:
      The vertical indent for next item, negative value indicates separator after.