public class RichTooltip extends Object
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 | +--------------------------------+
| Modifier and Type | Field and Description |
|---|---|
protected List<String> |
descriptionSections
The description sections of this tooltip.
|
protected Image |
footerImage
The footer image of this tooltip.
|
protected List<String> |
footerSections
The footer sections of this tooltip.
|
protected Image |
mainImage
The main image of this tooltip.
|
private boolean |
tipShowing |
private Popup |
tipWindow |
protected String |
title
The main title of this tooltip.
|
| Constructor and Description |
|---|
RichTooltip()
Creates an empty tooltip.
|
RichTooltip(String title,
String descriptionSection)
Creates a tooltip with the specified title and description section.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addDescriptionSection(String section)
Adds the specified description section to this tooltip.
|
void |
addFooterSection(String section)
Adds the specified footer section to this tooltip.
|
List<String> |
getDescriptionSections()
Returns an unmodifiable list of description sections of this tooltip.
|
Image |
getFooterImage()
Returns the footer image of this tooltip.
|
List<String> |
getFooterSections()
Returns an unmodifiable list of footer sections of this tooltip.
|
Image |
getMainImage()
Returns the main image of this tooltip.
|
String |
getTitle()
Returns the main title of this tooltip.
|
void |
hideTooltip() |
void |
setFooterImage(Image image)
Sets the footer image for this tooltip.
|
void |
setMainImage(Image image)
Sets the main image for this tooltip.
|
void |
setTitle(String title)
Sets the title for this tooltip.
|
void |
showTooltip(JComponent component) |
void |
showTooltip(JComponent component,
Point screenLocation) |
protected String title
RichTooltip(String, String),
setTitle(String),
getTitle()protected Image mainImage
null.getMainImage(),
setMainImage(Image)protected List<String> descriptionSections
protected Image footerImage
null.getFooterImage(),
setFooterImage(Image)protected List<String> footerSections
addFooterSection(String),
getFooterSections()private Popup tipWindow
private boolean tipShowing
public void showTooltip(JComponent component)
public void showTooltip(JComponent component, Point screenLocation)
public void hideTooltip()
public void setTitle(String title)
title - The new tooltip title.public void setMainImage(Image image)
image - The main image for this tooltip.getMainImage(),
addDescriptionSection(String)public void addDescriptionSection(String section)
section - The description section to add.getDescriptionSections(),
setMainImage(Image),
setTitle(String)public void setFooterImage(Image image)
image - The footer image for this tooltip.getFooterImage(),
addFooterSection(String)public void addFooterSection(String section)
section - The footer section to add.getFooterSections(),
setFooterImage(Image)public String getTitle()
RichTooltip(String, String),
setTitle(String)public Image getMainImage()
null.setMainImage(Image),
getDescriptionSections()public List<String> getDescriptionSections()
null list.RichTooltip(String, String),
addDescriptionSection(String),
getTitle(),
getMainImage()public Image getFooterImage()
null.setFooterImage(Image),
getFooterSections()public List<String> getFooterSections()
null list.addFooterSection(String),
getFooterImage()Copyright © 2007–2017 Gephi Consortium. All rights reserved.