ToolTipRegion Class

ToolTipRegion Class

This Package | All Packages

public class ToolTipRegion
implements IConstructable

A ToolTipRegion defines an area either by a rectangle or control that displays a tooltip when the mouse hovers over it.

Constructors
Name Description
ToolTipRegion(Control control, String caption) Creates a ToolTipRegion object.

Methods
Name Description
getCaption() Retrieves the caption that will be displayed when the mouse hovers over the region.
getControl() Retrieves the control that defines the region.
setCaption(String caption) Sets the caption to be displayed when the mouse hovers over this region.
setControl(Control boundControl) Sets the control that defines the region.

Constructors

ToolTipRegion.ToolTipRegion

Syntax
public ToolTipRegion( Control control, String caption );
Parameters
control
The control to make the tip for.
caption
The caption to display when the mouse hovers over the specified control.
Description

Creates a ToolTipRegion object.

Methods

ToolTipRegion.getCaption

Syntax
public String getCaption();
Return Value

Returns the caption.

Description

Retrieves the caption that will be displayed when the mouse hovers over the region.

See Also
setCaption

ToolTipRegion.getControl

Syntax
public Control getControl();
Return Value

Returns the control that defines the region.

Description

Retrieves the control that defines the region. This will be null if the region is bound to a rectangular region.

See Also
setControl

ToolTipRegion.setCaption

Syntax
public void setCaption( String caption );
Parameters
caption
The caption to display.
Description

Sets the caption to be displayed when the mouse hovers over this region.

See Also
getCaption

ToolTipRegion.setControl

Syntax
public void setControl( Control boundControl );
Parameters
boundControl
The control.
Description

Sets the control that defines the region.

See Also
getControl