HoverboardMaker (com.hfg API Documentation)

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

public class HoverboardMaker
extends Object

Generic hoverboard generation javascript. 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:

       HoverboardMaker hoverboardMaker = new HoverboardMaker();

       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(hoverboardMaker.generateJS());
       html.getHead().addJavascript(generateJS());

       // Add CSS
       html.getHead().addStyle(hoverboardMaker.generateCSS());

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

       // Create the target tag (in this case a span in a span) that the hoverboard will function on.
       Span span = body.addSpan("The quick ");
       hoverboardMaker.addHoverboard(span, "generateHoverboardContent");
       Span targetSpan = span.addSpan("brown").setId("hoverTarget");

       span.addContent(" fox jumped over the lazy dog");

       ...

       private String generateJS()
       {
          Pre content = new Pre();
          content.addSpan("Choose a door to open:\n").setStyle(CSS.BOLD + CSS.fontSize(24));
          content.addSpan("1. ").addLink("javascript:void(0);", "One");
          content.addSpan("\n2. ").addLink("javascript:void(0);", "Two");
          content.addSpan("\n3. ").addLink("javascript:void(0);", "Three");

          String contentString = content.toHTML();

          String safeString = StringUtil.replaceAll(contentString, "'", "\\'");
          safeString = StringUtil.replaceAll(safeString, "\n", "\\n");
          safeString = StringUtil.replaceAll(safeString, "\r", "\\r");

          StringBuffer js = new StringBuffer();

          js.append("//- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\n"
                    + "function generateHoverboardContent(inTargetElement)\n"
                    + "{\n"
                    + "  if (inTargetElement.id && inTargetElement.id == 'hoverTarget') {"
                    + "    return '" + safeString + "';\n"
                    + "  }\n"
                    + "}\n");

          return js.toString();
       }

Constructor Summary

Constructors
Constructor and Description

HoverboardMaker()

Constructors
Constructor and Description
`HoverboardMaker()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activateViaOnClick(boolean inValue)` Sets whether to trigger the hoverboard via an onclick() or an onmouseover().
`void`	`addHoverboard(HTMLTag inTag, String inJSMethodForContent)` Hoverboards can be added to any tag which supports onmouseover and onmouseout.
`String`	`generateCSS()`
`String`	`generateJS()`
`void`	`setBackgroundColor(Color inValue)`
`void`	`setBorder(String inValue)`
`void`	`setDelay(int inValue)`
`void`	`setFont(String inValue)`
`void`	`setFontColor(String inValue)`
`void`	`setFontSize(String inValue)`
`void`	`setPadding(int inValue)`
`void`	`setShadowColor(String inValue)`
`void`	`setShadowWidth(int inValue)`
`void`	`setWidth(int inValue)`
`void`	`setXOffset(int inValue)`
`void`	`setYOffset(int inValue)`

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

Constructor Detail
- HoverboardMaker
```
public HoverboardMaker()
```

Method Detail

activateViaOnClick
```
public void activateViaOnClick(boolean inValue)
```
Sets whether to trigger the hoverboard via an onclick() or an onmouseover().

setDelay
```
public void setDelay(int inValue)
```

setXOffset
```
public void setXOffset(int inValue)
```

setYOffset
```
public void setYOffset(int inValue)
```

setWidth
```
public void setWidth(int inValue)
```

setBorder

public void setBorder(String inValue)

setFont
```
public void setFont(String inValue)
```

setFontSize

public void setFontSize(String inValue)

setFontColor

public void setFontColor(String inValue)

setBackgroundColor

public void setBackgroundColor(Color inValue)

setPadding
```
public void setPadding(int inValue)
```

setShadowColor

public void setShadowColor(String inValue)

setShadowWidth

public void setShadowWidth(int inValue)

addHoverboard
```
public void addHoverboard(HTMLTag inTag,
                          String inJSMethodForContent)
```
Hoverboards 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 onclick() or onmouseover() attribute will be set to display a hoverboard.

inJSMethodForContent - the javascript method to call for content generation.

generateCSS
```
public String generateCSS()
```

generateJS
```
public String generateJS()
```

Class HoverboardMaker

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HoverboardMaker

Method Detail

activateViaOnClick

setDelay

setXOffset

setYOffset

setWidth

setBorder

setFont

setFontSize

setFontColor

setBackgroundColor

setPadding

setShadowColor

setShadowWidth

addHoverboard

generateCSS

generateJS