Chart Builder API (beta)): Class SequencedHyperLinkDesc

Overview

Package

Class

Tree

Deprecated

Index

Help

Chart Builder API (beta)

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.ord.media.chart.types
Class SequencedHyperLinkDesc

java.lang.Object
  |
  +--oracle.ord.media.chart.types.SequencedHyperLinkDesc

public class SequencedHyperLinkDesc
extends java.lang.Object

SequencedHyperLink objects allow control over the various components of expressions, such as href, onMouseOver, onMouseOut and onClick, generated in each area specification of an HTML image map.

When generating image map files, Chart Builder generates hyperlinks for each HTML area specification. The hyperlinks are numerically sequenced. The following example shows an the image map for a bar chart that contains three bars and that uses href expressions. The sequenced hyperlinks are shown in Italic font.

 
< area shape=rect coords=... href=foo0.html >
< area shape=rect coords=... href=foo1.html >
< area shape=rect coords=... href=foo2.html >

The default sequenced hyperlinks generated by Chart Builder are defined as follows:

For Pie Charts: A concatenation of mapName, sequence number, and ".html"
For Axis Charts: A concatenation of seriesName, sequence number, and ".html"

Sequenced hyperlinks are also embedded in expressions for handling mouse events, such as onMouseOver, as shown in the following example:

< area shape=rect coords=... href=foo0.html >
onMouseOver="document.images['barchart'].src='bars/worldpop0.gif' 
< area shape=rect coords=... href=foo1.html >
onMouseOver="document.images['barchart'].src='bars/worldpop1.gif' 
< area shape=rect coords=... href=foo2.html >
onMouseOver="document.images['barchart'].src='bars/worldpop2.gif'

In the example, "bars/worldpop0.gif" is the first sequenced hyperlink for the onMouseOver expression.

The SequencedHyperLinkDesc class allows one to alter the characteristics of sequenced hyperlinks:

Prefix: Use setHyperLinkPrefix(String). The default is a null string.
```
setHyperLinkPrefix("images/") => "images/foo0.html"
```
Name: Use setHyperLinkName(String). The default for pie charts is the map name. The default for axis charts is the series name.
```
setHyperLinkName("myname") => "myname0.html" 
```
Extension: Use setHyperLinkExtension(String). The default is ".html".
```
setHyperLinkExtension(".gif") => "foo0.gif"
```

Target and useMap expressions are also supported. By default, neither target nor useMap expressions are generated. For example, if one invoked setTarget("_blank") for the image map containing three bars, the generated HTML code would appear as follows:

  
< area shape=rect coords=... href=foo0.html target=_blank >
< area shape=rect coords=... href=foo1.html target=_blank >
< area shape=rect coords=... href=foo2.html target=_blank >

Similarly, if one invoked setUseMap("mymap") for the image map containing three bars, the generated HTML code would appear as follows:

 
< area shape=rect coords=... href=foo0.html useMap=#mymap0 >
< area shape=rect coords=... href=foo1.html useMap=#mymap1 >
< area shape=rect coords=... href=foo2.html useMap=#mymap2 >

Note that the useMap expressions are also sequenced.

Note: Although Internet Explorer provides support for useMap expressions within an image map, Netscape Navigator does not support useMap expressions within image maps.

See Also:: ImageMapDesc

Constructor Summary

SequencedHyperLinkDesc()


Method Summary

boolean getEnable()
          Get the enable flag of the hyperlink.

java.lang.String getHyperLinkExtension()
          Get the extension of the referenced hyperlink.

java.lang.String getHyperLinkName()
          Get the name of the referenced hyperlink.

java.lang.String getHyperLinkPrefix()
          Get the prefix of the referenced hyperlink.

int getHyperLinkStartIndex()
          Get the start index of the referenced hyperlink.

java.lang.String getTarget()
          Get the target of the sequenced hyperlink.

java.lang.String getUseMap()
          Get the useMap of the sequenced hyperlink.

void setDisable()
          Disable the generation of the sequenced hyperlink.

void setEnable()
          Enable the generation of the sequenced hyperlink.

void setHyperLinkExtension(java.lang.String extension)
          Set the extension of the referenced hyperlink.

void setHyperLinkName(java.lang.String name)
          Set the name of the referenced hyperlink.

void setHyperLinkPrefix(java.lang.String prefix)
          Set the prefix of the referenced hyperlink.

void setHyperLinkStartIndex(int startIndex)
          Set the index of the first sequenced hyperlink.

void setTarget(java.lang.String target)
          Set the target of the hyperlink.

void setUseMap(java.lang.String useMap)
          Set the useMap of the hyperlink.

Methods inherited from class java.lang.Object

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

Constructor Detail

SequencedHyperLinkDesc

public SequencedHyperLinkDesc()

Method Detail

setHyperLinkPrefix

public void setHyperLinkPrefix(java.lang.String prefix)

Set the prefix of the referenced hyperlink. The supplied prefix is prepended to the map or series name. For example, invoking setHyperLInkPrefix("images/") for a series named "foo" will result in "images/foo0.html" being generated instead of "foo0.html". Invoking this for an HREF would generate "href = images/foo0.html".

Parameters:: prefix - String to be used as the prefix.

setHyperLinkExtension

public void setHyperLinkExtension(java.lang.String extension)

Set the extension of the referenced hyperlink. The default extension is ".html"

Parameters:: extension - String to be used as the extension.

setHyperLinkName

public void setHyperLinkName(java.lang.String name)

Set the name of the referenced hyperlink. The default name is the map name for pie charts, and the series name for axis charts.

Parameters:: name - String to be used as the name of the hyperlink.

setHyperLinkStartIndex

public void setHyperLinkStartIndex(int startIndex)

Set the index of the first sequenced hyperlink. Subsequent indexes will each be incremented by one.

Parameters:: startIndex - The index for the first hyperlink.

setEnable

public void setEnable()

Enable the generation of the sequenced hyperlink.

setDisable

public void setDisable()

Disable the generation of the sequenced hyperlink.

setTarget

public void setTarget(java.lang.String target)

Set the target of the hyperlink. By default, no target will be generated.

Parameters:: target - The target of the hyperlink.

setUseMap

public void setUseMap(java.lang.String useMap)

Set the useMap of the hyperlink. By default, no useMap will be generated.

Parameters:: useMap - The name of the image map.

getHyperLinkPrefix

public java.lang.String getHyperLinkPrefix()

Get the prefix of the referenced hyperlink.

getHyperLinkExtension

public java.lang.String getHyperLinkExtension()

Get the extension of the referenced hyperlink.

getHyperLinkName

public java.lang.String getHyperLinkName()

Get the name of the referenced hyperlink.

getHyperLinkStartIndex

public int getHyperLinkStartIndex()

Get the start index of the referenced hyperlink.

getTarget

public java.lang.String getTarget()

Get the target of the sequenced hyperlink.

getUseMap

public java.lang.String getUseMap()

Get the useMap of the sequenced hyperlink.

getEnable

public boolean getEnable()

Get the enable flag of the hyperlink.