|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectinetsoft.report.Hyperlink
public class Hyperlink
Hyperlink defines a hyperlink to a report or a URL.
| Nested Class Summary | |
|---|---|
static class |
Hyperlink.Ref
Hyperlink.Ref contains the actual hyperlink and the link parameter values. |
| Field Summary | |
|---|---|
static int |
ARCHIVE_LINK
link to archived report |
static int |
DRILL_LINK
auto drill link |
static int |
REPORT_LINK
link to other report/replet |
static int |
VIEWSHEET_LINK
Link to a viewsheet. |
static int |
WEB_LINK
web link |
| Constructor Summary | |
|---|---|
Hyperlink()
Create an empty hyperlink. |
|
Hyperlink(String link)
Create a hyperlink. |
|
Hyperlink(String link,
boolean passParams)
Create a hyperlink. |
|
Hyperlink(String link,
boolean passParams,
boolean passSelectionParams)
Create a hyperlink. |
|
Hyperlink(String link,
int type)
Create a hyperlink. |
|
| Method Summary | |
|---|---|
Object |
clone()
Clone the object. |
boolean |
equals(Object obj)
Check if equals another object. |
String |
getBookmarkName()
Get the viewsheet bookmark name. |
String |
getBookmarkUser()
Get the viewsheet bookmark user. |
String |
getLink()
Get the hyperlink. |
int |
getLinkType()
Get the link type of this hyperlink |
int |
getParameterCount()
Get the number of parameters defined for this link. |
String |
getParameterField(String name)
Get the field value for the parameter. |
String |
getParameterLabel(String name)
Get the label value for the parameter. |
Enumeration |
getParameterNames()
Get all parameter names. |
String |
getParameterType(String name)
Get the type value for the hard-coded parameter. |
String |
getTargetFrame()
Get the hyperlink target frame. |
String |
getToolTip()
Get the tooltip. |
boolean |
isDisablePrompting()
Check whether to disable the prompting of the parameters on the target report. |
boolean |
isParameterHardCoded(String name)
Judge whether the parameter is hard-coded or not. |
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. |
boolean |
isSnapshot()
If the link entry is snapshot. |
void |
parseXML(Element tag)
Method to parse an xml segment. |
void |
removeAllParameterFields()
Remove all parameter fields. |
void |
removeParameterField(String name)
Remove a parameter field. |
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 |
setIsSnapshot(boolean isSnapshot)
Set the link if is snapshot. |
void |
setLink(String link)
Set the hyperlink. |
void |
setLinkType(int linkType)
Set the link type Type should be one of the constants in inetsoft.report.Hyperlink |
void |
setParameterField(String name,
String field)
Set the field name for the parameter. |
void |
setParameterLabel(String name,
String label)
Set the label name for the parameter. |
void |
setParameterType(String name,
String type)
Set the type name for the parameter. |
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. |
void |
setTargetFrame(String targetFrame)
Set the hyperlink target frame. |
void |
setToolTip(String tip)
Set the tooltip. |
String |
toString()
Get the string representation. |
void |
writeXML(PrintWriter writer)
Write the xml segment to print writer. |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final int REPORT_LINK
public static final int WEB_LINK
public static final int ARCHIVE_LINK
public static final int DRILL_LINK
public static final int VIEWSHEET_LINK
| Constructor Detail |
|---|
public Hyperlink()
public Hyperlink(String link)
link - link
public Hyperlink(String link,
boolean passParams)
link - link.passParams - true if send report parameters,
false otherwise.
public Hyperlink(String link,
boolean passParams,
boolean passSelectionParams)
link - link.passParams - true if send report parameters,false - otherwise.
public Hyperlink(String link,
int type)
link - linktype - link type| Method Detail |
|---|
public void setLink(String link)
link - for Web URL, the link must be the full URL including
the protocol. If the link is to another report, it should be the
report path as registered in report server.public String getLink()
public void setTargetFrame(String targetFrame)
targetFrame - is the window name for hyperlinkpublic String getTargetFrame()
public void setToolTip(String tip)
public String getToolTip()
public void setBookmarkName(String bookmarkName)
bookmarkName - the name of bookmark in vs.public String getBookmarkName()
public void setBookmarkUser(String bookmarkUser)
bookmarkName - the user of bookmark in vs.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 setIsSnapshot(boolean isSnapshot)
isSnapshot - if is snapshotpublic boolean isSnapshot()
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 Enumeration getParameterNames()
public int getParameterCount()
public String getParameterLabel(String name)
public String getParameterField(String name)
public String getParameterType(String name)
public void setParameterLabel(String name,
String label)
name - parameter name.label - label name.
public void setParameterField(String name,
String field)
name - parameter name.field - field name.
public void setParameterType(String name,
String type)
name - parameter name.type - type name.public boolean isParameterHardCoded(String name)
name - parameter name.public void removeParameterField(String name)
name - parameter name.public void removeAllParameterFields()
public boolean equals(Object obj)
equals in class Objectpublic String toString()
toString in class Objectpublic Object clone()
clone in class Objectpublic void writeXML(PrintWriter writer)
writeXML in interface inetsoft.util.XMLSerializablewriter - the destination print writer.
public void parseXML(Element tag)
throws Exception
parseXML in interface inetsoft.util.XMLSerializableException
|
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 | ||||||||