oracle.javatools.ui.infotip

Enum InfoTipStyles

java.lang.Object

java.lang.Enum<InfoTipStyles>

oracle.javatools.ui.infotip.InfoTipStyles

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<InfoTipStyles>

public enum InfoTipStyles
extends java.lang.Enum<InfoTipStyles>

A collection of the various types of InfoTip styles. The look of an InfoTip will vary slightly depending of it's InfoTipStyle.

To ensure consistency of design between different instances of InfoTips, the contents of an InfoTip should adhere to the settings for each of the particular styles. The look of the InfoTip itself will automatically adjust to suit the given style.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CODE An infoTip style for use above source code.
DEFAULT A default InfoTip style for general use.

Method Summary

Methods

Modifier and Type	Method and Description
java.awt.Color	getBackgroundBorderColor()
LinearGradientPainter	getBackgroundPainter()
java.awt.Insets	getBorderInsets()
java.awt.Color	getContentTextColor()
java.awt.Color	getHyperLinkTextColor(boolean isHover)
java.awt.Color	getInternalBorderColor()
java.awt.Color	getItemTextColor()
java.awt.Font	getItemTitleFont()
java.awt.Insets	getItemTitleInsets()
java.awt.Color	getMoreTextColor()
javax.swing.Icon	scaleIcon(javax.swing.Icon originalIcon) Some infotip styles scale their internal icons to be slightly smaller so the tip is more compact.
static InfoTipStyles	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static InfoTipStyles[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEFAULT

public static final InfoTipStyles DEFAULT

A default InfoTip style for general use.

CODE

public static final InfoTipStyles CODE

An infoTip style for use above source code.

Method Detail

values

public static InfoTipStyles[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (InfoTipStyles c : InfoTipStyles.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static InfoTipStyles valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getBackgroundPainter

public LinearGradientPainter getBackgroundPainter()

Returns:

the painter that fills the entire background of the InfoTip.

getBackgroundBorderColor

public java.awt.Color getBackgroundBorderColor()

Returns:

the color used to render the border of the InfoTip.

getInternalBorderColor

public java.awt.Color getInternalBorderColor()

Returns:

the color used to render the border of internal content panels

scaleIcon

public javax.swing.Icon scaleIcon(javax.swing.Icon originalIcon)

Some infotip styles scale their internal icons to be slightly smaller so the tip is more compact. Others do not scale icons. Running the icons through this method will either return a scaled icon or the original (depending on the info tip style).

Parameters:

originalIcon -

Returns:

the icon to use in the InfoTip (scaled or otherwise).

getItemTitleFont

public java.awt.Font getItemTitleFont()

Returns:

the font to be used by the an item title.

getItemTitleInsets

public java.awt.Insets getItemTitleInsets()

Returns:

the padding to go around the title of the infotip.

getBorderInsets

public java.awt.Insets getBorderInsets()

Returns:

the inset padding to insert around the content of the InfoTip.

getContentTextColor

public java.awt.Color getContentTextColor()

Returns:

the color used to render content text in the InfoTip.

getItemTextColor

public java.awt.Color getItemTextColor()

Returns:

the color used to render content text in the InfoTip.

getMoreTextColor

public java.awt.Color getMoreTextColor()

Returns:

the color used to render 'more' expansion text button in the InfoTip.

getHyperLinkTextColor

public java.awt.Color getHyperLinkTextColor(boolean isHover)

Parameters:

isHover - the color may be different if the mouse is hovering over the hyperlink

Returns:

the color used to render hyperlink text (such as 'fixes') in the content ofthe InfoTip.