Class HelpLink

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.sun.javatest.tool.HelpLink

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

HelpExternalLink

public class HelpLink
extends JComponent
implements Accessible

A lightweight component that will activate online help, suitable for use in More Info help panes. To use this component in More Info, use the following:

   <object classid="java:com.sun.javatest.tool.HelpLink">
   <param  name=... value=...>
   ...
   </object>

The following parameters are recognized:

target

the help ID that will be displayed when the link is activated

text

the text string that will be displayed as the body of the link

textFont

the font used to display the link

textColor

the color used to display the link

See Also:

• HelpLinkBeanInfo
• HelpExternalLink
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HELPBROKER_FOR_HELPLINK	The name of a property that must be set on the JHelpContentViewer that identifies the HelpBroker that is updated when the link is activated.

Fields inherited from class JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Modifier	Constructor	Description
	HelpLink()	Create a HelpLink object.
protected	HelpLink(Object o)	A constructor used to specify another MouseListener by subclasses

Method Summary

Modifier and Type	Method	Description
AccessibleContext	getAccessibleContext()	Get the accessible context for this pane.
Dimension	getPreferredSize()
String	getTarget()	Get the help ID that will be displayed when the link is activated.
String	getText()	Get the text string that will be displayed as the body of the link.
String	getTextColor()	Get the color that will be used to display the link.
String	getTextFont()	Get the font that will be used to display the link.
void	paintComponent(Graphics g)
void	setTarget(String target)	Set the help ID that will be displayed when the link is activated.
void	setText(String text)	Set the text string that will be displayed as the body of the link.
void	setTextColor(String color)	Set the color that will be used to display the link.
void	setTextFont(String font)	Set the font that will be used to display the link.

Methods inherited from class JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUI, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class Object

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

Field Details

HELPBROKER_FOR_HELPLINK

public static final String HELPBROKER_FOR_HELPLINK

The name of a property that must be set on the JHelpContentViewer that identifies the HelpBroker that is updated when the link is activated.

See Also:

• Constant Field Values

Constructor Details

HelpLink

public HelpLink()

Create a HelpLink object.

HelpLink

protected HelpLink(Object o)

A constructor used to specify another MouseListener by subclasses

Parameters:

o - fake param - not used

Method Details

getAccessibleContext

public AccessibleContext getAccessibleContext()

Get the accessible context for this pane.

Specified by:

getAccessibleContext in interface Accessible

Overrides:

getAccessibleContext in class Component

Returns:

the accessible context for this pane

getPreferredSize

public Dimension getPreferredSize()

Overrides:

getPreferredSize in class JComponent

paintComponent

public void paintComponent(Graphics g)

Overrides:

paintComponent in class JComponent

getTarget

public String getTarget()

Get the help ID that will be displayed when the link is activated.

Returns:

the help ID that will be displayed when the link is activated

See Also:

• setTarget(String)

setTarget

public void setTarget(String target)

Set the help ID that will be displayed when the link is activated. The ID must be set before the link is displayed.

Parameters:

target - the help ID that will be displayed when the link is activated

See Also:

• getTarget()

getText

public String getText()

Get the text string that will be displayed as the body of the link.

Returns:

the text string that will be displayed as the body of the link

See Also:

• setText(String)

setText

public void setText(String text)

Set the text string that will be displayed as the body of the link. The text must be set before the link is displayed.

Parameters:

text - the text string that will be displayed as the body of the link

See Also:

• getText()

getTextFont

public String getTextFont()

Get the font that will be used to display the link. The default font is inherited from the context in which the link appears.

Returns:

the name of the font that will be used to display the link

See Also:

• setTextFont(String)

setTextFont

public void setTextFont(String font)

Set the font that will be used to display the link.

Parameters:

font - the name of font that will be used to display the link

See Also:

• getTextFont()

getTextColor

public String getTextColor()

Get the color that will be used to display the link. The default color is blue.

Returns:

a string giving the color that will be used to display the link

See Also:

• setTextColor(String)

setTextColor

public void setTextColor(String color)

Set the color that will be used to display the link.

Parameters:

color - the name of color that will be used to display the link

See Also:

• getTextColor()