Package com.microstrategy.web.objects.rw
Interface RWHyperlink
-
public interface RWHyperlink
- Since:
- MicroStrategy Web 9.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static int
LINK_TYPE_EXECUTE
static int
LINK_TYPE_URL
static int
PROMPT_ANSWER_TYPE_MSGID
static int
PROMPT_ANSWER_TYPE_NO_ANSWER
static int
PROMPT_ANSWER_TYPE_XML
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addAttribute(java.lang.String attrID)
Adds a new attribute to the attributes collectionvoid
clearAttributes()
WebAttribute[]
getAttributes()
Returns a modifiable list of attributesjava.lang.String
getDisplayText()
java.lang.String
getHyperlink()
Returns the url (@see #getURL()) if the hyperlink is of typeLINK_TYPE_URL
If the hyperlink is of typeLINK_TYPE_EXECUTE
, then a hyperlink representation based on the current parameters is returnedint
getLinkType()
Returns the type of linkint
getPromptAnswersType()
WebObjectInfo
getTargetObject()
java.lang.String
getURL()
Returns the url (if any) associated with the hyperlinkboolean
isDefault()
Indicates whether this is the default urlboolean
openInNewWindow()
void
setDefault(boolean def)
Set the current hyperlink as the defaultvoid
setDisplayText(java.lang.String text)
void
setLinkType(int type)
void
setOpenInNewWindow(boolean open)
void
setPromptsAnswersType(int type)
void
setTargetObject(WebObjectInfo obj)
void
setURL(java.lang.String url)
-
-
-
Field Detail
-
PROMPT_ANSWER_TYPE_NO_ANSWER
static final int PROMPT_ANSWER_TYPE_NO_ANSWER
- See Also:
- Constant Field Values
-
PROMPT_ANSWER_TYPE_MSGID
static final int PROMPT_ANSWER_TYPE_MSGID
- See Also:
- Constant Field Values
-
PROMPT_ANSWER_TYPE_XML
static final int PROMPT_ANSWER_TYPE_XML
- See Also:
- Constant Field Values
-
LINK_TYPE_URL
static final int LINK_TYPE_URL
- See Also:
- Constant Field Values
-
LINK_TYPE_EXECUTE
static final int LINK_TYPE_EXECUTE
- See Also:
- Constant Field Values
-
-
Method Detail
-
getAttributes
WebAttribute[] getAttributes()
Returns a modifiable list of attributes
-
addAttribute
void addAttribute(java.lang.String attrID) throws java.lang.IllegalArgumentException
Adds a new attribute to the attributes collection- Parameters:
attrID
-- Throws:
java.lang.IllegalArgumentException
- if the attribute ID that is passed in does not correspond to a valid attribute in one of the datasets
-
getURL
java.lang.String getURL()
Returns the url (if any) associated with the hyperlink
-
setURL
void setURL(java.lang.String url)
-
getLinkType
int getLinkType()
Returns the type of link
-
setLinkType
void setLinkType(int type)
-
isDefault
boolean isDefault()
Indicates whether this is the default url
-
setDefault
void setDefault(boolean def)
Set the current hyperlink as the default- Parameters:
def
-
-
getDisplayText
java.lang.String getDisplayText()
-
setDisplayText
void setDisplayText(java.lang.String text)
-
openInNewWindow
boolean openInNewWindow()
-
setOpenInNewWindow
void setOpenInNewWindow(boolean open)
-
getTargetObject
WebObjectInfo getTargetObject()
-
setTargetObject
void setTargetObject(WebObjectInfo obj)
-
getPromptAnswersType
int getPromptAnswersType()
-
setPromptsAnswersType
void setPromptsAnswersType(int type)
-
getHyperlink
java.lang.String getHyperlink()
Returns the url (@see #getURL()) if the hyperlink is of typeLINK_TYPE_URL
If the hyperlink is of typeLINK_TYPE_EXECUTE
, then a hyperlink representation based on the current parameters is returned
-
clearAttributes
void clearAttributes()
-
-