Class RichTooltip


  • public class RichTooltip
    extends Object
    Rich tooltip for command buttons.

    In its most basic form, the rich tooltip has a title and one (possible multiline) description text:

     +--------------------------------+
     | Title                          |
     |        Some description text   |
     +--------------------------------+
     

    The addDescriptionSection(String) can be used to add multiple sections to the description:

     +--------------------------------+
     | Title                          |
     |        First multiline         |
     |        description section     |
     |                                |
     |        Second multiline        |
     |        description section     |
     |                                |
     |        Third multiline         |
     |        description section     |
     +--------------------------------+
     

    The setMainImage(Image) can be used to place an image below the title and to the left of the description sections:

     +--------------------------------+
     | Title                          |
     | *******  First multiline       |
     | *image*  description section   |
     | *******                        |
     |          Second multiline      |
     |          description section   |
     +--------------------------------+
     

    The addFooterSection(String) can be used to add (possibly) multiple footer sections that will be shown below a horizontal separator:

     +--------------------------------+
     | Title                          |
     |        First multiline         |
     |        description section     |
     |                                |
     |        Second multiline        |
     |        description section     |
     |--------------------------------|
     | A multiline footer section     |
     | placed below a separator       |
     +--------------------------------+
     

    The setFooterImage(Image) can be used to place an image to the left of the footer sections:

     +--------------------------------+
     | Title                          |
     |        First multiline         |
     |        description section     |
     |                                |
     |        Second multiline        |
     |        description section     |
     |--------------------------------|
     | *******  A multiline           |
     | *image*  footer section        |
     | *******                        |
     +--------------------------------+
     

    Here is a fully fledged rich tooltip that shows all these APIs in action:

     +--------------------------------+
     | Title                          |
     | *******  First multiline       |
     | *image*  description section   |
     | *******                        |
     |          Second multiline      |
     |          description section   |
     |--------------------------------|
     | *******  First multiline       |
     | *image*  footer section        |
     | *******                        |
     |          Second multiline      |
     |          footer section        |
     +--------------------------------+