|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectinetsoft.graph.data.HRef
inetsoft.report.Hyperlink.Ref
public static class Hyperlink.Ref
Hyperlink.Ref contains the actual hyperlink and the link parameter values.
| 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 |
|---|
public Hyperlink.Ref()
public Hyperlink.Ref(String link)
link - link.
public Hyperlink.Ref(String link,
boolean passParams)
link - link.passParams - true if send report parameters,
false otherwise.
public Hyperlink.Ref(String link,
boolean passParams,
boolean passSelectionParams)
link - link.passParams - true if send report parameters,
false otherwise.
public Hyperlink.Ref(String link,
int type)
link - link.type - link type.
public Hyperlink.Ref(String link,
int type,
boolean isGuessed)
link - link.type - link type.isGuessed - Check whether the type is guessed type.public Hyperlink.Ref(Hyperlink link)
public Hyperlink.Ref(Hyperlink link,
Map map)
public Hyperlink.Ref(Hyperlink link,
TableLens table,
int row,
int col)
public Hyperlink.Ref(DrillPath path)
public Hyperlink.Ref(DrillPath path,
Map map)
public Hyperlink.Ref(DrillPath path,
TableLens table,
int row,
int col)
| Method Detail |
|---|
public void setDrillData(DrillPath path,
TableLens table,
int r,
int c)
public void setLinkData(Hyperlink link,
TableLens table,
int row)
public void setName(String name)
public String getName()
public void setQuery(String query)
public String getQuery()
public void setBookmarkName(String bookmarkName)
public String getBookmarkName()
public void setBookmarkUser(String bookmarkUser)
public String getBookmarkUser()
public void setReportLink(boolean reportLink)
reportLink - true to set this hyperlink to a report link
and false otherwise.public boolean isReportLink()
public void setLinkType(int linkType)
linkType - link typepublic int getLinkType()
public void setSendReportParameters(boolean pass)
pass - true to pass all report parameters. It defaults to true.public boolean isSendReportParameters()
public void setSendSelectionParameters(boolean pass)
pass - true to pass all report parameters. It defaults to true.public boolean isSendSelectionParameters()
public void setDisablePrompting(boolean disable)
public boolean isDisablePrompting()
public Object getParameter(String name)
getParameter in class HRef
public void setParameter(String name,
Object data)
setParameter in class HRefname - parameter name.data - parameter value.
public void setParameters(Map map,
Hyperlink link)
map - the Map contains field-value pair valueslink - the HyperLink.Ref's corresponding Hyperlinkpublic void writeXML(PrintWriter writer)
writeXML in interface inetsoft.util.XMLSerializable
public void parseXML(Element tag)
throws IOException
parseXML in interface inetsoft.util.XMLSerializableIOExceptionpublic String toString()
toString in class Objectpublic boolean equals(Object obj)
equals in class HRef
|
Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved. | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||