oracle.javatools.ui.infotip.templates

Class SingleItemTemplate

java.lang.Object

oracle.javatools.ui.infotip.templates.BasicTemplate

oracle.javatools.ui.infotip.templates.SingleItemTemplate

All Implemented Interfaces:

ActiveTemplate, ItemTemplate, Template

public final class SingleItemTemplate
extends BasicTemplate
implements ItemTemplate

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.

Fields inherited from class oracle.javatools.ui.infotip.templates.BasicTemplate

content

Fields inherited from interface oracle.javatools.ui.infotip.templates.ActiveTemplate

ACTION_CLOSE_INFOTIP_CMD, ACTION_REMOVE_TEMPLATE_CMD, ACTION_SIZE_CHANGED_CMD

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

Modifier and Type	Method and Description
int	getPreferredWidth() Returns preffered width of this template regardless of prior calls to ItemTemplate.setPreferredWidth(int).
void	setHover(InfoTipHover hover) Deprecated. There is no need to supply the InfoTipHover to the template directly. Request to the info tip are now handled through action listeners in ActionTemplate.
void	setPreferredWidth(int width) Sets the preferred width of this template.

Methods inherited from class oracle.javatools.ui.infotip.templates.BasicTemplate

addActionListener, fireActionPerformed, getContent, removeActionListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.javatools.ui.infotip.templates.ActiveTemplate

addActionListener, removeActionListener

Methods inherited from interface oracle.javatools.ui.infotip.templates.Template

getContent

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

setHover

public void setHover(InfoTipHover hover)

Deprecated. There is no need to supply the InfoTipHover to the template directly. Request to the info tip are now handled through action listeners in ActionTemplate.

Set the InfoTipHover which is displaying this template.

getPreferredWidth

public int getPreferredWidth()

Description copied from interface: ItemTemplate

Returns preffered width of this template regardless of prior calls to ItemTemplate.setPreferredWidth(int). Width should be derived from some important components in the template (for example from title label).

Specified by:

getPreferredWidth in interface ItemTemplate

setPreferredWidth

public void setPreferredWidth(int width)

Description copied from interface: ItemTemplate

Sets the preferred width of this template.

Specified by:

setPreferredWidth in interface ItemTemplate