Class ScriptPageStateTagHelper
- java.lang.Object
-
- com.microstrategy.web.app.taglibs.CoreTagHelper
-
- com.microstrategy.web.app.taglibs.MstrPageTagHelper
-
- com.microstrategy.web.app.taglibs.AbstractNoBodyTagHelper
-
- com.microstrategy.web.app.taglibs.ScriptPageStateTagHelper
-
public class ScriptPageStateTagHelper extends AbstractNoBodyTagHelper
Helper for theScriptPageStateTag
tag library.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
-
Fields inherited from class com.microstrategy.web.app.taglibs.MstrPageTagHelper
_mstrPage
-
-
Constructor Summary
Constructors Constructor Description ScriptPageStateTagHelper()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
cleanState()
Resets the state of the tag library, by cleaning the values of the properties initialized for this tag.MarkupOutput
getContent()
Obtains the contents to render based on the attributes that have been defined (if existing).void
setDisplayMode(java.lang.String value)
set the display mode used when the GuiComponent renders itselfvoid
setPersistParameters(java.lang.String persistParams)
Indicates a list of parameters need to be persisted in page statevoid
setUpdateWindow(boolean value)
Sets the value assigned to the updateWindow attribute of the custom tag instance that uses this helper-
Methods inherited from class com.microstrategy.web.app.taglibs.MstrPageTagHelper
getContainerServices, newHiddenInputBuilder, newURIBuilder, resolveNumericAttribute, setPageComponent
-
Methods inherited from class com.microstrategy.web.app.taglibs.CoreTagHelper
getTagsFactory
-
-
-
-
Method Detail
-
cleanState
public void cleanState()
Resets the state of the tag library, by cleaning the values of the properties initialized for this tag.- Overrides:
cleanState
in classMstrPageTagHelper
-
getContent
public MarkupOutput getContent() throws java.io.IOException
Obtains the contents to render based on the attributes that have been defined (if existing).- Specified by:
getContent
in classAbstractNoBodyTagHelper
- Returns:
- a
MarkupOutput
instance initialized with the contents to display - Throws:
java.io.IOException
- if an error happens while getting the contents to render.
-
setUpdateWindow
public void setUpdateWindow(boolean value)
Sets the value assigned to the updateWindow attribute of the custom tag instance that uses this helper- Parameters:
value
-boolean
indicating if the window should be updated or not.
-
setDisplayMode
public void setDisplayMode(java.lang.String value)
set the display mode used when the GuiComponent renders itself- Parameters:
value
- String the display mode:AppContext.DISPLAY_MODE_HTML
- plain HTMLAppContext.DISPLAY_MODE_JSON
- the output will be wrapped up in a json structure in form of {id: id of the component, content: html content to be updated} or {id: if of the component, components: sub json blocks}- Since:
- MicroStrategy Web 9.0.1
-
setPersistParameters
public void setPersistParameters(java.lang.String persistParams)
Indicates a list of parameters need to be persisted in page state- Parameters:
persistParams
-String
a comma seperated string. Such as "name1,name2".- Since:
- MicroStrategy Web 8.0.2
-
-