Overview  Package   Class  Tree  Deprecated  Index 
Chart FX 7 for Java Server
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.softwarefx.chartfx.server
Class Link

java.lang.Object
  extended by com.softwarefx.chartfx.server.Link

public class Link
extends Object

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 .

Constructor Summary
Link()
           
 
Method Summary
 String getOnClick()
          Gets the OnClick.
 String getOnContextMenu()
          Gets the OnContextMenu.
 String getOnMouseDown()
          Gets the OnMouseDown.
 String getOnMouseOut()
          Gets the OnMouseOut.
 String getOnMouseOver()
          Gets the OnMouseOver.
 String getOnMouseUp()
          Gets the OnMouseUp.
 String getPostBackUrl()
          Gets the PostBackUrl.
 String getTarget()
          Gets the Target.
 String getUrl()
          Gets the Url.
 boolean isPostBack()
          Gets the PostBack.
 boolean isReload()
          Gets the Reload.
 void setOnClick(String value)
          Sets the name of the client-side JavaScript to be executed when the user clicks on the link.
 void setOnContextMenu(String value)
          Sets the name of the client-side JavaScript to be executed before the Context Menu pops-up.
 void setOnMouseDown(String value)
          Sets the name of the client-side JavaScript to be executed when the user presses down the mouse on the link.
 void setOnMouseOut(String value)
          Sets the name of the client-side JavaScript to be executed when the cursor leaves the area where the link is defined.
 void setOnMouseOver(String value)
          Sets the name of the client-side JavaScript to be executed when the cursor hovers the link.
 void setOnMouseUp(String value)
          Sets the name of the client-side JavaScript to be executed when the user releases the mouse button on the link.
 void setPostBack(boolean value)
          Sets a value indicating whether or not a postback will occur when the link is clicked.
 void setPostBackUrl(String value)
          Sets the URL of the Web page to post to from the current page 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

getOnClick

public String getOnClick()

Gets the OnClick. For more detail see setOnClick(java.lang.String).

getOnContextMenu

public String getOnContextMenu()

Gets the OnContextMenu. For more detail see setOnContextMenu(java.lang.String).

getOnMouseDown

public String getOnMouseDown()

Gets the OnMouseDown. For more detail see setOnMouseDown(java.lang.String).

getOnMouseOut

public String getOnMouseOut()

Gets the OnMouseOut. For more detail see setOnMouseOut(java.lang.String).

getOnMouseOver

public String getOnMouseOver()

Gets the OnMouseOver. For more detail see setOnMouseOver(java.lang.String).

getOnMouseUp

public String getOnMouseUp()

Gets the OnMouseUp. For more detail see setOnMouseUp(java.lang.String).

getPostBackUrl

public String getPostBackUrl()

Gets the PostBackUrl. For more detail see setPostBackUrl(java.lang.String).

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).

setOnClick

public void setOnClick(String value)

Sets the name of the client-side JavaScript to be executed when the user clicks on the link.

Remarks:

  • This property accepts as string the JavaScript function name to call when the OnClick event is handled for the link.

  • The Chart.getImageSettings() property is used to access the ImageSettings object of a chart. Many of the supported members are useful when working with Image Maps and ImageSettings.setInteractive(boolean) images.

    • See Also:
    Chart.getImageSettings(), setOnContextMenu(java.lang.String), setOnMouseDown(java.lang.String), setOnMouseOut(java.lang.String), setOnMouseOver(java.lang.String), ImageSettings, Chart

    setOnContextMenu

    public void setOnContextMenu(String value)

    Sets the name of the client-side JavaScript to be executed before the Context Menu pops-up.

    Remarks:

  • This property accepts as string the JavaScript function name to call when the OnContextMenu event is handled for the link.

  • The Chart.getImageSettings() property is used to access the ImageSettings object of a chart. Many of the supported members are useful when working with Image Maps and ImageSettings.setInteractive(boolean) images.

    • See Also:
    Chart.getImageSettings(), setOnContextMenu(java.lang.String), setOnMouseDown(java.lang.String), setOnMouseOut(java.lang.String), setOnMouseOver(java.lang.String), ImageSettings, Chart

    setOnMouseDown

    public void setOnMouseDown(String value)

    Sets the name of the client-side JavaScript to be executed when the user presses down the mouse on the link.

    Remarks:

  • This property accepts as string the JavaScript function name to call when the OnMouseDown event is handled for the link.

  • The Chart.getImageSettings() property is used to access the ImageSettings object of a chart. Many of the supported members are useful when working with Image Maps and ImageSettings.setInteractive(boolean) images.

    • See Also:
    Chart.getImageSettings(), setOnContextMenu(java.lang.String), setOnMouseOut(java.lang.String), setOnMouseOver(java.lang.String), ImageSettings, Chart

    setOnMouseOut

    public void setOnMouseOut(String value)

    Sets the name of the client-side JavaScript to be executed when the cursor leaves the area where the link is defined.

    Remarks:

  • This property accepts as string the JavaScript function name to call when the OnMouseOut event is handled for the link.

  • The Chart.getImageSettings() property is used to access the ImageSettings object of a chart. Many of the supported members are useful when working with Image Maps and ImageSettings.setInteractive(boolean) images.

    • See Also:
    Chart.getImageSettings(), setOnContextMenu(java.lang.String), setOnMouseDown(java.lang.String), setOnMouseOut(java.lang.String), setOnMouseOver(java.lang.String), ImageSettings, Chart

    setOnMouseOver

    public void setOnMouseOver(String value)

    Sets the name of the client-side JavaScript to be executed when the cursor hovers the link.

    Remarks:

  • This property accepts as string the JavaScript function name to call when the OnMouseOver event is handled for the link.

  • The Chart.getImageSettings() property is used to access the ImageSettings object of a chart. Many of the supported members are useful when working with Image Maps and ImageSettings.setInteractive(boolean) images.

    • See Also:
    Chart.getImageSettings(), setOnContextMenu(java.lang.String), setOnMouseDown(java.lang.String), setOnMouseOut(java.lang.String), setOnMouseOver(java.lang.String), ImageSettings, Chart

    setOnMouseUp

    public void setOnMouseUp(String value)

    Sets the name of the client-side JavaScript to be executed when the user releases the mouse button on the link.

    Remarks:

  • This property accepts as string the JavaScript function name to call when the OnMouseUp event is handled for the link.

  • The Chart.getImageSettings() property is used to access the ImageSettings object of a chart. Many of the supported members are useful when working with Image Maps and ImageSettings.setInteractive(boolean) images.

    • See Also:
    Chart.getImageSettings(), setOnContextMenu(java.lang.String), setOnMouseDown(java.lang.String), setOnMouseOut(java.lang.String), setOnMouseOver(java.lang.String), ImageSettings, Chart

    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 setPostBackUrl(java.lang.String) 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), setPostBackUrl(java.lang.String), setTarget(java.lang.String), setReload(boolean), Link

    setPostBackUrl

    public void setPostBackUrl(String value)

    Sets the URL of the Web page to post to from the current page when the link is clicked.

    Remarks:

  • The setPostBack(boolean) property gets or sets a value indicating whether or not a postback will occur when the link is clicked.

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

  • 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:
    setPostBack(boolean), setUrl(java.lang.String), 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
    Overview  Package   Class  Tree  Deprecated  Index 
    		http://www.softwarefx.com
     PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
    SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
    2008 Software FX, Inc. All Rights Reserved. Chart FX is a registered trademark of Software FX, Inc
    All other names are trademarks or registered trademarks of their respective owners.