Class ContextMenusTagHelper
- java.lang.Object
-
- com.microstrategy.web.app.taglibs.CoreTagHelper
-
- com.microstrategy.web.app.taglibs.MstrPageTagHelper
-
- com.microstrategy.web.app.taglibs.AbstractBodyTagHelper
-
- com.microstrategy.web.app.taglibs.ContextMenusTagHelper
-
public class ContextMenusTagHelper extends AbstractBodyTagHelper
Helper for theContextMenusTag
tag library.- Since:
- MicroStrategy Web 8.0.0
-
-
Field Summary
-
Fields inherited from class com.microstrategy.web.app.taglibs.MstrPageTagHelper
_mstrPage
-
-
Constructor Summary
Constructors Constructor Description ContextMenusTagHelper()
-
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
getContentHead()
Obtains the contents to render based on the attributes defined (if existing).MarkupOutput
getContentTail()
Obtains the contents to render after the tag's body.boolean
isTagVisible()
Indicates whether the tags is visiblevoid
setBaseBean(java.lang.String value)
Sets the value assigned to the baseBean attribute of the custom tag instance that uses this helpervoid
setMenusName(java.lang.String value)
Indicates the name of the menu in the page-config to be used for context-menus.void
setName(java.lang.String value)
Indicates the name of the context-menu in the page.boolean
shallRepeatTag()
Indicates if the content of the tag should be analyzed and displayed again or not.-
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
-
getContentHead
public MarkupOutput getContentHead() throws java.io.IOException
Obtains the contents to render based on the attributes defined (if existing).- Specified by:
getContentHead
in classAbstractBodyTagHelper
- Returns:
- a
MarkupOutput
instance initialized with the contents to display - Throws:
java.io.IOException
- if an error happens while getting the contents to render.
-
getContentTail
public MarkupOutput getContentTail()
Obtains the contents to render after the tag's body.- Specified by:
getContentTail
in classAbstractBodyTagHelper
- Returns:
- a
MarkupOutput
instance initialized with the contents to display
-
isTagVisible
public boolean isTagVisible()
Indicates whether the tags is visible- Specified by:
isTagVisible
in classAbstractBodyTagHelper
- Returns:
- a
boolean
indicating whether the tag should be displayed or not
-
shallRepeatTag
public boolean shallRepeatTag()
Indicates if the content of the tag should be analyzed and displayed again or not.- Specified by:
shallRepeatTag
in classAbstractBodyTagHelper
- Returns:
- a
boolean
value indicating if the tag contents should be analyzed again or not.
-
setName
public void setName(java.lang.String value)
Indicates the name of the context-menu in the page.
Usage:
This attributes helps the javascript code to identify the context menus within the page. It needs to be a unique identifier for the menus and a valid JavaScript variable name. If not specified, one will be automatically assigned.- Parameters:
value
-String
value with the name for the context-menus.
-
setMenusName
public void setMenusName(java.lang.String value)
Indicates the name of the menu in the page-config to be used for context-menus.
Usage:
The name needs to be a validshortcut-list-set
of the<menus>
section in the page-config.- Parameters:
value
-String
the name of menu.
-
setBaseBean
public void setBaseBean(java.lang.String value)
Sets the value assigned to the baseBean attribute of the custom tag instance that uses this helper- Parameters:
value
-boolean
indicating if the GUI Component is a container or not
-
-