oracle.javatools.ui.infotip.templates

Class SingleItemTemplate

java.lang.Object

oracle.javatools.ui.infotip.templates.SingleItemTemplate

All Implemented Interfaces:

Template

public final class SingleItemTemplate
extends java.lang.Object
implements Template

A standard template to show one item in an InfoTip.

An item can consist of: A title, a description, and an optional number of actions that can be performed on the item.

Each action can also have a separate 'configure' action associated with it.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SingleItemTemplate.Severity

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIGURE Actions that can be configured will have a 'configure' button placed next to the action.

Constructor Summary

Constructors

Constructor and Description
SingleItemTemplate(SingleItemTemplate.Severity severity, java.lang.String title, java.lang.String description, java.util.List<? extends javax.swing.Action> actions, InfoTipStyles infoTipStyle)
SingleItemTemplate(SingleItemTemplate.Severity severity, java.lang.String title, java.lang.String description, java.util.List<? extends javax.swing.Action> actions, InfoTipStyles infoTipStyle, int maxWidth)

Method Summary

Methods

Modifier and Type	Method and Description
javax.swing.JComponent	getContent()
void	setHover(InfoTipHover hover)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONFIGURE

public static final java.lang.String CONFIGURE

Actions that can be configured will have a 'configure' button placed next to the action. To programatically mark an action as configurable it must return as true. When the configure button is pressed the action will be called with a ActionEvent with an action command of CONFIGURE.

See Also:

Constant Field Values

Constructor Detail

SingleItemTemplate

public SingleItemTemplate(SingleItemTemplate.Severity severity,
                  java.lang.String title,
                  java.lang.String description,
                  java.util.List<? extends javax.swing.Action> actions,
                  InfoTipStyles infoTipStyle)

SingleItemTemplate

public SingleItemTemplate(SingleItemTemplate.Severity severity,
                  java.lang.String title,
                  java.lang.String description,
                  java.util.List<? extends javax.swing.Action> actions,
                  InfoTipStyles infoTipStyle,
                  int maxWidth)

Method Detail

getContent

public javax.swing.JComponent getContent()

Specified by:

getContent in interface Template

Returns:

the JComponent that containing the content.

setHover

public void setHover(InfoTipHover hover)