com.softwarefx.chartfx.desktop
Class Link

java.lang.Object
  com.softwarefx.chartfx.desktop.Link

All Implemented Interfaces:

Serializable

public class Link
extends Object
implements Serializable

Provides access to the Link object.

The Link Class members allow developers to get and set attributes for Link objects obtained from other chart elements.

Many of the chart objects support a Link property that may be used to return a Link object: SeriesAttributes, PointAttributes, Title, CustomGridLine, Axis, etc.

Once a developer has obtained this object, attributes may be configured using the members of this Class .

See Also:

Serialized Form

Constructor Summary

Link()

Method Summary

String	getTarget() Gets the Target.
String	getUrl() Gets the Url.
boolean	isPostBack() Gets the PostBack.
boolean	isReload() Gets the Reload.
void	setPostBack(boolean value) Sets a value indicating whether or not a postback will occur when the link is clicked.
void	setReload(boolean value) Sets a value specifying if the chart is to be reloaded.
void	setTarget(String value) Sets the target frame or HTML Frame to be used when jumping to a URL.
void	setUrl(String value) Sets a URL for a Link object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Link

public Link()

Method Detail

getTarget

public String getTarget()

Gets the Target. For more detail see setTarget(java.lang.String).

getUrl

public String getUrl()

Gets the Url. For more detail see setUrl(java.lang.String).

isPostBack

public boolean isPostBack()

Gets the PostBack. For more detail see setPostBack(boolean).

isReload

public boolean isReload()

Gets the Reload. For more detail see setReload(boolean).

setPostBack

public void setPostBack(boolean value)

Sets a value indicating whether or not a postback will occur when the link is clicked.

Remarks:

The setUrl(java.lang.String) property gets or sets a URL for a Link object.

The Link#setPostBackUrl property gets or sets the URL of the Web page to post to from the current page when the link is clicked.

The setTarget(java.lang.String) property gets or sets the target frame or HTML Frame to be used when jumping to a URL.

The setReload(boolean) property gets or sets a value specifying if the chart is to be reloaded.

See Also:

setUrl(java.lang.String), Link#setPostBackUrl, setTarget(java.lang.String), setReload(boolean), Link

setReload

public void setReload(boolean value)

Sets a value specifying if the chart is to be reloaded.

Remarks:

This property instructs Chart FX to ONLY reload the chart when the item is clicked in a drilldown event.

This feature requires the chart to be reloaded to be bit-streamed by using the Chart#renderToStream method.

The setUrl(java.lang.String) property is used to cofigure a target url for a link object.

To specify the target frame for the URL, you can use the setTarget(java.lang.String) property of the Link Object.

See Also:

setTarget(java.lang.String), setUrl(java.lang.String), Chart#renderToStream, Chart, Axis, PointAttributes, SeriesAttributes, Title, CustomGridLine

setTarget

public void setTarget(String value)

Sets the target frame or HTML Frame to be used when jumping to a URL.

Remarks:

This property can be configured with the "_blank" string value to open the link in a new window.

The web address to jump or reload can be set using the setUrl(java.lang.String) property.

See Also:

setUrl(java.lang.String), setReload(boolean), Chart, Axis, PointAttributes, SeriesAttributes, Title, CustomGridLine

setUrl

public void setUrl(String value)

Sets a URL for a Link object.

Remarks:

When the URL target page is located in the same physical directory as the current page, you can specify the target file name only:

If you wish to jump to another domain, you should configure the full web address:

To specify the target frame for the URL, you can use the setTarget(java.lang.String) property of the Link Object.

The syntax for this property is the same as the one used in the PointLabelAttributes.setFormat(java.lang.String) property. Variables can be accessed using the % following the variable you want to include:

l Shows X-Axis Legend.

k Shows X-Axis Key Legend.

s Shows Series Legend.

S Shows the Series Index.

x Shows XValue (XY charts, when they were set with X values).

i Shows IniValues (Gantt).

v Shows Data Value.

v <n> For types that require more than one series, these are replaced by the value of each one. (n represents an index).

t Series Total (Sum of all points in this series).

p Percentage of total this point represents (Pie).

T Point Total (Sum of all series for this point).

P Percentage of total this series represents (Used in stacked charts).

X displays the marker X value for any chart type including those that do not support X values such as bar.

N Shows the index for the point.

L Shows the PointAttributes.setTag(java.lang.Object)property of the PointAttributes object.

See Also:

setTarget(java.lang.String), setReload(boolean), Chart, Axis, PointAttributes, SeriesAttributes, Title, CustomGridLine, CustomLegendItem