TooltipJS (com.hfg API Documentation)

java.lang.Object
- com.hfg.javascript.TooltipJS

public class TooltipJS
extends Object

Generic tooltip generation javascript. Tooltips can be added to any tag which supports onmouseover and onmouseout. You will also need to add generateJS() to the javascript in the page's <head> tag.

See this page for tooltip examples.

Simple code example:

       TooltipJS tooltip = new TooltipJS();

       HTMLDoc htmlDoc = new HTMLDoc();

       // Keep IE from going into quirks mode.
       htmlDoc.setDoctype(Doctype.HTML_4_01_TRANSITIONAL_NO_URL);

       HTML html = new HTML();
       htmlDoc.setRootTag(html);
       html.getHead().addSubtag(Meta.CONTENT_TYPE_ISO_8859_1);

       // Add the necessary javascript to the page.
       html.getHead().addJavascript(tooltip.generateJS());

       Body body = html.getBody();
       body.br(2);

       // Create the target tag (in this case a span) the tooltip will function on.
       Span testSpan = body.addSpan("Test span");

       // Create the tooltip content
       Pre tooltip1Content = new Pre("foobar and all that stuff\n");
       tooltip1Content.addSpan("just grinds my axe!\n").setStyle(CSS.BOLD + CSS.fontSize(24));

       // Attach the tooltip to the target.
       tooltip.addTooltip(testSpan, tooltip1Content.toHTML());

Constructor Summary

Constructors
Constructor and Description

TooltipJS()

Constructors
Constructor and Description
`TooltipJS()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTitleTooltip(XMLNode inTag)` Creates a tooltip using the tag's 'title' attribute as the tooltip text.
`void`	`addTooltip(XMLNode inTag, String inValue)` Tooltips can be added to any tag which supports onmouseover and onmouseout.
`String`	`generateJS()`
`TooltipJS`	`setBackgroundColor(String inValue)`
`TooltipJS`	`setBorder(String inValue)`
`TooltipJS`	`setDelay(int inValue)`
`TooltipJS`	`setFont(String inValue)`
`TooltipJS`	`setFontColor(String inValue)`
`TooltipJS`	`setFontSize(String inValue)`
`TooltipJS`	`setMaxWidth(int inValue)` Sets the suggested maximum width for tooltips.
`TooltipJS`	`setMouseMove(boolean inValue)` Move the tooltip via onmousemove().
`TooltipJS`	`setPadding(int inValue)`
`TooltipJS`	`setShadowColor(String inValue)`
`TooltipJS`	`setShadowOffset(int inValue)`
`TooltipJS`	`setXOffset(int inValue)`
`TooltipJS`	`setYOffset(int inValue)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TooltipJS
```
public TooltipJS()
```
- Method Detail
  - setDelay
```
public TooltipJS setDelay(int inValue)
```
  - setXOffset
```
public TooltipJS setXOffset(int inValue)
```
  - setYOffset
```
public TooltipJS setYOffset(int inValue)
```
  - setBorder
```
public TooltipJS setBorder(String inValue)
```
  - setFont
```
public TooltipJS setFont(String inValue)
```
  - setFontSize
```
public TooltipJS setFontSize(String inValue)
```
  - setFontColor
```
public TooltipJS setFontColor(String inValue)
```
  - setBackgroundColor
```
public TooltipJS setBackgroundColor(String inValue)
```
  - setPadding
```
public TooltipJS setPadding(int inValue)
```
  - setShadowColor
```
public TooltipJS setShadowColor(String inValue)
```
  - setMaxWidth
```
public TooltipJS setMaxWidth(int inValue)
```
    Sets the suggested maximum width for tooltips. If content cannot be squeezed into this width, such as is sometimes the case with Pre's, tables, etc., the the tooltip will grow. It will always enclose all of the content.
    
    Parameters:
    
    inValue -
  - setShadowOffset
```
public TooltipJS setShadowOffset(int inValue)
```
  - setMouseMove
```
public TooltipJS setMouseMove(boolean inValue)
```
    Move the tooltip via onmousemove().
  - addTooltip
```
public void addTooltip(XMLNode inTag,
                       String inValue)
```
    Tooltips can be added to any tag which supports onmouseover and onmouseout. You will also need to add generateJS() to the javascript in the page's <head> tag.
    
    Parameters:
    
    inTag - the tag to which the onmouseover and onmouseout attributes will be set to display a popup tooltip.
    
    inValue - the text or HTML to display in the tooltip.
  - addTitleTooltip
```
public void addTitleTooltip(XMLNode inTag)
```
    Creates a tooltip using the tag's 'title' attribute as the tooltip text.
    
    Parameters:
    
    inTag - the tag to which the onmouseover and onmouseout attributes will be added in order to display the popup tooltip.
  - generateJS
```
public String generateJS()
```

Class TooltipJS

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TooltipJS

Method Detail

setDelay

setXOffset

setYOffset

setBorder

setFont

setFontSize

setFontColor

setBackgroundColor

setPadding

setShadowColor

setMaxWidth

setShadowOffset

setMouseMove

addTooltip

addTitleTooltip

generateJS