oracle.javatools.ui.infotip.templates

Class BalloonTemplate

java.lang.Object

oracle.javatools.ui.infotip.templates.BasicTemplate

oracle.javatools.ui.infotip.templates.BalloonTemplate

All Implemented Interfaces:

ActiveTemplate, ItemTemplate, Template

public final class BalloonTemplate
extends BasicTemplate
implements ItemTemplate

Template for a 'balloon' like infotip that can float next to a component until the user hits the built in close button, or an optional timer is hit, or the InfoTip is programatically closed.

It is advisable to add subcomponents only via the explicit 'set' methods on this class and not via calling 'add' directly.

Clients can listen for clicks inside the balloon by registering actionListeners.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_CLICK_CMD Action command to indicate the ballon was clicked

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
BalloonTemplate() Creates a new balloon.

Method Summary

Modifier and Type	Method and Description
javax.swing.JComponent	getContent()
int	getPreferredWidth() Returns preffered width of this template regardless of prior calls to ItemTemplate.setPreferredWidth(int).
void	setContent(javax.swing.JComponent content) Set the main content for the center of the balloon.
void	setFooter(javax.swing.JComponent footerComponent) Set component to appear in the footer area.
void	setPreferredWidth(int width) Sets the preferred width of this template.
void	setTitle(javax.swing.Icon icon, java.lang.String title) Set text and icon to be displayed for the InfoTip
void	setTitle(javax.swing.JComponent titleComponent) Set component to appear in the title area.

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

addActionListener, fireActionPerformed, 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

Field Detail

ACTION_CLICK_CMD

public static final java.lang.String ACTION_CLICK_CMD

Action command to indicate the ballon was clicked

See Also:

Constant Field Values

Constructor Detail

BalloonTemplate

public BalloonTemplate()

Creates a new balloon.

Method Detail

getContent

public javax.swing.JComponent getContent()

Specified by:

getContent in interface Template

Overrides:

getContent in class BasicTemplate

setContent

public void setContent(javax.swing.JComponent content)

Set the main content for the center of the balloon.

Parameters:

content -

setTitle

public void setTitle(javax.swing.Icon icon,
                     java.lang.String title)

Set text and icon to be displayed for the InfoTip

Parameters:

icon - An icon to display in the title (may be null)

title -

setTitle

public void setTitle(javax.swing.JComponent titleComponent)

Set component to appear in the title area.

Parameters:

titleComponent - the component to display at the top of the balloon.

setFooter

public void setFooter(javax.swing.JComponent footerComponent)

Set component to appear in the footer area.

Parameters:

footerComponent - the component to display at the bottom of the balloon.

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