Style Intelligence v12.0

inetsoft.report
Class Hyperlink.Ref

java.lang.Object
  extended by inetsoft.graph.data.HRef
      extended by inetsoft.report.Hyperlink.Ref
All Implemented Interfaces:
inetsoft.util.XMLSerializable, Serializable
Enclosing class:
Hyperlink

public static class Hyperlink.Ref
extends HRef
implements inetsoft.util.XMLSerializable

Hyperlink.Ref contains the actual hyperlink and the link parameter values.

See Also:
Serialized Form

Constructor Summary
Hyperlink.Ref()
          Create an empty hyperlink.
Hyperlink.Ref(DrillPath path)
          Create a hyperlink def from a drill path.
Hyperlink.Ref(DrillPath path, Map map)
          Create a hyperlink def from a drill path.
Hyperlink.Ref(DrillPath path, TableLens table, int row, int col)
          Create a hyperlink def from a drill path.
Hyperlink.Ref(Hyperlink link)
          Create a hyperlink def from a hyperlink definition.
Hyperlink.Ref(Hyperlink link, Map map)
          Create a hyperlink def from a table and a hyperlink definition.
Hyperlink.Ref(Hyperlink link, TableLens table, int row, int col)
          Create a hyperlink def from a table and a hyperlink definition.
Hyperlink.Ref(String link)
          Create a hyperlink def.
Hyperlink.Ref(String link, boolean passParams)
          Create a hyperlink def.
Hyperlink.Ref(String link, boolean passParams, boolean passSelectionParams)
          Create a hyperlink def.
Hyperlink.Ref(String link, int type)
          Create a hyperlink ref.
Hyperlink.Ref(String link, int type, boolean isGuessed)
          Create a hyperlink ref.
 
Method Summary
 boolean equals(Object obj)
          Check if equals another Hyperlink.Ref.
 String getBookmarkName()
          Get the viewsheet bookmark name.
 String getBookmarkUser()
          Get the viewsheet bookmark User.
 int getLinkType()
          Get the link type of this hyperlink
 String getName()
          Get the hyperlink name.
 Object getParameter(String name)
          Get the value for the parameter.
 String getQuery()
          Get the query name.
 boolean isDisablePrompting()
          Check whether to disable the prompting of the parameters on the target report.
 boolean isReportLink()
          Deprecated. as of 6.0, use getLinkType() == Hyperlink.REPORT_LINK
 boolean isSendReportParameters()
          Check if to pass all report parameters to the linked report.
 boolean isSendSelectionParameters()
          Check if to pass all report parameters to the linked report.
 void parseXML(Element tag)
          Parse and recreate a Hyperlink.
 void setBookmarkName(String bookmarkName)
          Set the viewsheet bookmark name.
 void setBookmarkUser(String bookmarkUser)
          Set the viewsheet bookmark user.
 void setDisablePrompting(boolean disable)
          Set whether to disable the prompting of the parameters on the target report.
 void setDrillData(DrillPath path, TableLens table, int r, int c)
          Set drill data.
 void setLinkData(Hyperlink link, TableLens table, int row)
          Set the link definition from link and extract parameter values from a table row.
 void setLinkType(int linkType)
          Set the link type Type should be one of the constants in inetsoft.report.Hyperlink
 void setName(String name)
          Set the hyperlink name.
 void setParameter(String name, Object data)
          Set the value for the parameter.
 void setParameters(Map map, Hyperlink link)
          Set parameters of the Hyperlink.Ref.
 void setQuery(String query)
          Set the query name.
 void setReportLink(boolean reportLink)
          Deprecated. as of 6.0, use setLinkType()
 void setSendReportParameters(boolean pass)
          Set whether to pass all report parameters to the link report.
 void setSendSelectionParameters(boolean pass)
          Set whether to pass all report parameters to the link report.
 String toString()
           
 void writeXML(PrintWriter writer)
          Write this hyperlink definition to XML.
 
Methods inherited from class inetsoft.graph.data.HRef
getLink, getParameterCount, getParameterNames, getTargetFrame, getToolTip, removeAllParameters, removeParameter, setLink, setTargetFrame, setToolTip
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Hyperlink.Ref

public Hyperlink.Ref()
Create an empty hyperlink. The setLink() must be called to set the hyperlink before it can be used.


Hyperlink.Ref

public Hyperlink.Ref(String link)
Create a hyperlink def.

Parameters:
link - link.

Hyperlink.Ref

public Hyperlink.Ref(String link,
                     boolean passParams)
Create a hyperlink def.

Parameters:
link - link.
passParams - true if send report parameters, false otherwise.

Hyperlink.Ref

public Hyperlink.Ref(String link,
                     boolean passParams,
                     boolean passSelectionParams)
Create a hyperlink def.

Parameters:
link - link.
passParams - true if send report parameters, false otherwise.

Hyperlink.Ref

public Hyperlink.Ref(String link,
                     int type)
Create a hyperlink ref.

Parameters:
link - link.
type - link type.

Hyperlink.Ref

public Hyperlink.Ref(String link,
                     int type,
                     boolean isGuessed)
Create a hyperlink ref.

Parameters:
link - link.
type - link type.
isGuessed - Check whether the type is guessed type.

Hyperlink.Ref

public Hyperlink.Ref(Hyperlink link)
Create a hyperlink def from a hyperlink definition.


Hyperlink.Ref

public Hyperlink.Ref(Hyperlink link,
                     Map map)
Create a hyperlink def from a table and a hyperlink definition.


Hyperlink.Ref

public Hyperlink.Ref(Hyperlink link,
                     TableLens table,
                     int row,
                     int col)
Create a hyperlink def from a table and a hyperlink definition.


Hyperlink.Ref

public Hyperlink.Ref(DrillPath path)
Create a hyperlink def from a drill path.


Hyperlink.Ref

public Hyperlink.Ref(DrillPath path,
                     Map map)
Create a hyperlink def from a drill path.


Hyperlink.Ref

public Hyperlink.Ref(DrillPath path,
                     TableLens table,
                     int row,
                     int col)
Create a hyperlink def from a drill path.

Method Detail

setDrillData

public void setDrillData(DrillPath path,
                         TableLens table,
                         int r,
                         int c)
Set drill data.


setLinkData

public void setLinkData(Hyperlink link,
                        TableLens table,
                        int row)
Set the link definition from link and extract parameter values from a table row.


setName

public void setName(String name)
Set the hyperlink name.


getName

public String getName()
Get the hyperlink name.


setQuery

public void setQuery(String query)
Set the query name.


getQuery

public String getQuery()
Get the query name.


setBookmarkName

public void setBookmarkName(String bookmarkName)
Set the viewsheet bookmark name.


getBookmarkName

public String getBookmarkName()
Get the viewsheet bookmark name.


setBookmarkUser

public void setBookmarkUser(String bookmarkUser)
Set the viewsheet bookmark user.


getBookmarkUser

public String getBookmarkUser()
Get the viewsheet bookmark User.


setReportLink

public void setReportLink(boolean reportLink)
Deprecated. as of 6.0, use setLinkType()

Set link as a report link

Parameters:
reportLink - true to set this hyperlink to a report link and false otherwise.

isReportLink

public boolean isReportLink()
Deprecated. as of 6.0, use getLinkType() == Hyperlink.REPORT_LINK

Check if this link is a report link

Returns:
true if this hyperlink object links to a report

setLinkType

public void setLinkType(int linkType)
Set the link type Type should be one of the constants in inetsoft.report.Hyperlink

Parameters:
linkType - link type

getLinkType

public int getLinkType()
Get the link type of this hyperlink

Returns:
link type

setSendReportParameters

public void setSendReportParameters(boolean pass)
Set whether to pass all report parameters to the link report.

Parameters:
pass - true to pass all report parameters. It defaults to true.

isSendReportParameters

public boolean isSendReportParameters()
Check if to pass all report parameters to the linked report. It defaults to true.


setSendSelectionParameters

public void setSendSelectionParameters(boolean pass)
Set whether to pass all report parameters to the link report.

Parameters:
pass - true to pass all report parameters. It defaults to true.

isSendSelectionParameters

public boolean isSendSelectionParameters()
Check if to pass all report parameters to the linked report. It defaults to true.


setDisablePrompting

public void setDisablePrompting(boolean disable)
Set whether to disable the prompting of the parameters on the target report.


isDisablePrompting

public boolean isDisablePrompting()
Check whether to disable the prompting of the parameters on the target report.


getParameter

public Object getParameter(String name)
Get the value for the parameter.

Overrides:
getParameter in class HRef

setParameter

public void setParameter(String name,
                         Object data)
Set the value for the parameter.

Overrides:
setParameter in class HRef
Parameters:
name - parameter name.
data - parameter value.

setParameters

public void setParameters(Map map,
                          Hyperlink link)
Set parameters of the Hyperlink.Ref.

Parameters:
map - the Map contains field-value pair values
link - the HyperLink.Ref's corresponding Hyperlink

writeXML

public void writeXML(PrintWriter writer)
Write this hyperlink definition to XML.

Specified by:
writeXML in interface inetsoft.util.XMLSerializable

parseXML

public void parseXML(Element tag)
              throws IOException
Parse and recreate a Hyperlink.

Specified by:
parseXML in interface inetsoft.util.XMLSerializable
Throws:
IOException

toString

public String toString()
Overrides:
toString in class Object

equals

public boolean equals(Object obj)
Check if equals another Hyperlink.Ref.

Overrides:
equals in class HRef

Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.