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 intLINK_TYPE_EXECUTEstatic intLINK_TYPE_URLstatic intPROMPT_ANSWER_TYPE_MSGIDstatic intPROMPT_ANSWER_TYPE_NO_ANSWERstatic intPROMPT_ANSWER_TYPE_XML
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddAttribute(java.lang.String attrID)Adds a new attribute to the attributes collectionvoidclearAttributes()WebAttribute[]getAttributes()Returns a modifiable list of attributesjava.lang.StringgetDisplayText()java.lang.StringgetHyperlink()Returns the url (@see #getURL()) if the hyperlink is of typeLINK_TYPE_URLIf the hyperlink is of typeLINK_TYPE_EXECUTE, then a hyperlink representation based on the current parameters is returnedintgetLinkType()Returns the type of linkintgetPromptAnswersType()WebObjectInfogetTargetObject()java.lang.StringgetURL()Returns the url (if any) associated with the hyperlinkbooleanisDefault()Indicates whether this is the default urlbooleanopenInNewWindow()voidsetDefault(boolean def)Set the current hyperlink as the defaultvoidsetDisplayText(java.lang.String text)voidsetLinkType(int type)voidsetOpenInNewWindow(boolean open)voidsetPromptsAnswersType(int type)voidsetTargetObject(WebObjectInfo obj)voidsetURL(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.IllegalArgumentExceptionAdds 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_URLIf the hyperlink is of typeLINK_TYPE_EXECUTE, then a hyperlink representation based on the current parameters is returned
-
clearAttributes
void clearAttributes()
-
-