oracle.javatools.ui.infotip.templates

Class BasicTemplate

java.lang.Object

oracle.javatools.ui.infotip.templates.BasicTemplate

All Implemented Interfaces:

Closeable, Template

Direct Known Subclasses:

ActionTemplate

public class BasicTemplate
extends java.lang.Object
implements Template, Closeable

An implementation of an infotip template that can contain any content.

Note: To conform to ui standards and create a consistent user interface a specific template implementation from this package should be used in preference to creating a custom template.

The template also contains a basic action listener framework. Templates can close their hovers by firing ACTION_CLOSE_CMD, or can fire custom actions.

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.swing.JComponent	content

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

ACTION_CLOSE_CMD

Constructor Summary

Constructors

Constructor and Description
BasicTemplate(javax.swing.JComponent content) Create a template with custom content.

Method Summary

Methods

Modifier and Type	Method and Description
void	addActionListener(java.awt.event.ActionListener l) Add an actionListener to receive actions such as close from the Template.
protected void	fireActionPerformed(java.lang.String command) Notifies all listeners that an action has occurred.
javax.swing.JComponent	getContent()
void	removeActionListener(java.awt.event.ActionListener l) Remove an previously added ActionListener.

Methods inherited from class java.lang.Object

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

Field Detail

content

protected final javax.swing.JComponent content

Constructor Detail

BasicTemplate

public BasicTemplate(javax.swing.JComponent content)

Create a template with custom content.

Parameters:

content -

Method Detail

getContent

public javax.swing.JComponent getContent()

Specified by:

getContent in interface Template

addActionListener

public void addActionListener(java.awt.event.ActionListener l)

Description copied from interface: Closeable

Add an actionListener to receive actions such as close from the Template.

Specified by:

addActionListener in interface Closeable

removeActionListener

public void removeActionListener(java.awt.event.ActionListener l)

Description copied from interface: Closeable

Remove an previously added ActionListener.

Specified by:

removeActionListener in interface Closeable

fireActionPerformed

protected void fireActionPerformed(java.lang.String command)

Notifies all listeners that an action has occurred.

Parameters:

command - the cmd string to notify listeners (e.g. Closeable.ACTION_CLOSE_CMD to close the hover).