Package com.microstrategy.web.app.taglibs

Class EventTagHelper

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.EventTagHelper

Direct Known Subclasses:

FormEventTagHelper, UrlEventTagHelper

public abstract class EventTagHelper
extends AbstractBodyTagHelper

Helper for the EventTag tag library.

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	_linkAttributes	Property used for saving the value of the linkAttributes tag attribute specified by the user
protected java.lang.String	baseBean	Property used for saving the value of the baseBean tag attribute specified by the user
protected boolean	checkEnabled	Indicates if the event has already been checked if it's enabled or not, regardless of the result
protected java.lang.String	cssClass	Property used for saving the value of the cssClass tag attribute specified by the user
protected java.lang.String	enabledCssClass	Property used for saving the value of the enabledCssClass tag attribute specified by the user
protected java.lang.String	enableEvent	Property used for saving the value of the enableEvent tag attribute specified by the user
protected WebEvent	event	Event to use, generated based on the eventID tag attribute
protected java.lang.Exception	eventEx
protected java.lang.String	eventID	Property used for saving the value of the eventID tag attribute specified by the user
protected java.lang.String	extraURL	Property used for saving the value of the extraURL tag attribute specified by the user
protected boolean	includeState	Property used for saving the value of the includeState tag attribute specified by the user
protected static int	LINK_DISABLED	Constant that indicates the event is disabled
protected static int	LINK_ENABLED	Constant that indicates the event is enabled
protected static int	LINK_UNKNOWN	Constant that indicates the event has not yet been determined to be enabled or not.
protected int	linkIsEnabled	Property that indicates if the event is enabled or not, using the LINK_UNKNOWN, LINK_ENABLED or LINK_DISABLED values
protected java.lang.String	rel	Property used for saving the value of the rel tag attribute specified by the user
protected int	stateLevel	Property used for saving the value of the stateLevel tag attribute specified by the user
protected java.lang.String	target	Property used for saving the value of the target tag attribute specified by the user
protected java.lang.String	titleID	Property used for saving the value of the titleID tag attribute specified by the user.

Fields inherited from class com.microstrategy.web.app.taglibs.MstrPageTagHelper

_mstrPage

Constructor Summary

Constructors

Constructor	Description
EventTagHelper()

Method Summary

Modifier and Type	Method	Description
void	addEventArgument(java.lang.String name, java.lang.String value, java.lang.String type, java.lang.String base)	Utility method for adding an event argument to the event definition of this tag.
void	cleanState()	Resets the state of the tag library, by cleaning the values of the properties initialized for this tag.
protected WebEvent	getEvent()	Based on the eventID tag attribute, creates the event to use for this tag, considering the base bean (specified on the baseBean attribute.
boolean	isLinkEnabled()	Indicates if the link (URL) information related with this tag is enabled or not, based on the feature indicated on the enableEvent attribute.
boolean	isTagVisible()	Indicates if the tag is visible or not.
void	setBaseBean(java.lang.String value)	Sets the value assigned to the baseBean attribute of the custom tag instance that uses this helper
void	setCssClass(java.lang.String value)	Sets the value assigned to the cssClass attribute of the custom tag instance that uses this helper
void	setEnabledCssClass(java.lang.String value)	Gets the value assigned to the enabledCssClass attribute of the custom tag instance that uses this helper
void	setEnableEvent(java.lang.String value)	Sets the value assigned to the enableEvent attribute of the custom tag instance that uses this helper
void	setEventID(java.lang.String value)	Sets the value assigned to the eventID attribute of the custom tag instance that uses this helper
void	setExtraURL(java.lang.String value)	Sets the value assigned to the extraURL attribute of the custom tag instance that uses this helper
void	setIncludeState(boolean value)	Sets the value assigned to the includeState attribute of the custom tag instance that uses this helper
void	setLinkAttributes(java.lang.String value)	Sets the value assigned to the linkAttributes attribute of the custom tag instance that uses this helper
void	setRel(java.lang.String value)	Sets the value assigned to the rel attribute of the custom tag instance that uses this helper
void	setStateLevel(int value)	Sets the value assigned to the stateLevel attribute of the custom tag instance that uses this helper
void	setTarget(java.lang.String value)	Sets the value assigned to the target attribute of the custom tag instance that uses this helper
void	setTitleID(java.lang.String value)	Sets the value assigned to the titleID attribute of the custom tag instance that uses this helper
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.AbstractBodyTagHelper

getContentHead, getContentTail

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LINK_UNKNOWN

protected static final int LINK_UNKNOWN

Constant that indicates the event has not yet been determined to be enabled or not.

See Also:

Constant Field Values

LINK_ENABLED

protected static final int LINK_ENABLED

Constant that indicates the event is enabled

See Also:

Constant Field Values

LINK_DISABLED

protected static final int LINK_DISABLED

Constant that indicates the event is disabled

See Also:

Constant Field Values

eventEx

protected java.lang.Exception eventEx

Since:

MicroStrategy Web 7.5.1

cssClass

protected java.lang.String cssClass

Property used for saving the value of the cssClass tag attribute specified by the user

eventID

protected java.lang.String eventID

Property used for saving the value of the eventID tag attribute specified by the user

target

protected java.lang.String target

Property used for saving the value of the target tag attribute specified by the user

rel

protected java.lang.String rel

Property used for saving the value of the rel tag attribute specified by the user

includeState

protected boolean includeState

Property used for saving the value of the includeState tag attribute specified by the user

stateLevel

protected int stateLevel

Property used for saving the value of the stateLevel tag attribute specified by the user

enableEvent

protected java.lang.String enableEvent

Property used for saving the value of the enableEvent tag attribute specified by the user

extraURL

protected java.lang.String extraURL

Property used for saving the value of the extraURL tag attribute specified by the user

baseBean

protected java.lang.String baseBean

Property used for saving the value of the baseBean tag attribute specified by the user

_linkAttributes

protected java.lang.String _linkAttributes

Property used for saving the value of the linkAttributes tag attribute specified by the user

Since:

MicroStrategy Web 8.0.0

enabledCssClass

protected java.lang.String enabledCssClass

Property used for saving the value of the enabledCssClass tag attribute specified by the user

event

protected WebEvent event

Event to use, generated based on the eventID tag attribute

checkEnabled

protected boolean checkEnabled

Indicates if the event has already been checked if it's enabled or not, regardless of the result

linkIsEnabled

protected int linkIsEnabled

Property that indicates if the event is enabled or not, using the LINK_UNKNOWN, LINK_ENABLED or LINK_DISABLED values

titleID

protected java.lang.String titleID

Property used for saving the value of the titleID tag attribute specified by the user. this should be descriptor id.

Since:

MicroStrategy Web 9.0.0

Constructor Detail

EventTagHelper

public EventTagHelper()

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 class MstrPageTagHelper

isTagVisible

public boolean isTagVisible()

Indicates if the tag is visible or not. In this case, it checks if there's a valid event associated with the tag.

Specified by:

isTagVisible in class AbstractBodyTagHelper

Returns:

a boolean value indicating if the tag is visible 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 class AbstractBodyTagHelper

Returns:

a boolean value indicating if the tag contents should be analyzed again or not.

isLinkEnabled

public boolean isLinkEnabled()

Indicates if the link (URL) information related with this tag is enabled or not, based on the feature indicated on the enableEvent attribute.

Returns:

a boolean value indicating if the link is enabled or not.

addEventArgument

public void addEventArgument(java.lang.String name,
                             java.lang.String value,
                             java.lang.String type,
                             java.lang.String base)

Utility method for adding an event argument to the event definition of this tag. Typically, this method will be called by the EventArgumentTag custom tag defined as child.

Parameters:

name - full package, class name and constant that identifies the argument name to add to the event

value - value to assign to the event argument

type - to specify if the event value will come from another event (value would be eventParameter)

base - full package, class name and constant that identifies the event which will be used as base for defining the main event argument value.

setCssClass

public void setCssClass(java.lang.String value)

Sets the value assigned to the cssClass attribute of the custom tag instance that uses this helper

Parameters:

value - String value that defines the css class to use.

setEventID

public void setEventID(java.lang.String value)

Sets the value assigned to the eventID attribute of the custom tag instance that uses this helper

Parameters:

value - String value that defines the event to use for this tag.

setTarget

public void setTarget(java.lang.String value)

Sets the value assigned to the target attribute of the custom tag instance that uses this helper

Parameters:

value - String value that defines the target information for the event.

setRel

public void setRel(java.lang.String value)

Sets the value assigned to the rel attribute of the custom tag instance that uses this helper

Parameters:

value - String value that defines the relationship type for this link.

setIncludeState

public void setIncludeState(boolean value)

Sets the value assigned to the includeState attribute of the custom tag instance that uses this helper

Parameters:

value - boolean value that indicates if the states of the beans should be added to the resulting URL information.

setStateLevel

public void setStateLevel(int value)

Sets the value assigned to the stateLevel attribute of the custom tag instance that uses this helper

Parameters:

value - int value that indicates the level of information of the bean states to use.

setEnableEvent

public void setEnableEvent(java.lang.String value)

Sets the value assigned to the enableEvent attribute of the custom tag instance that uses this helper

Parameters:

value - String value that indicates the feature to check for enabling the event.

setEnabledCssClass

public void setEnabledCssClass(java.lang.String value)

Gets the value assigned to the enabledCssClass attribute of the custom tag instance that uses this helper

Parameters:

value - String value that defines the css to use for the enabled events.

setExtraURL

public void setExtraURL(java.lang.String value)

Sets the value assigned to the extraURL attribute of the custom tag instance that uses this helper

Parameters:

value - String value with the extra attributes to include on the HTML tag to create for this event.

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 - int value that indicates the base bean for the event to generate.

setLinkAttributes

public void setLinkAttributes(java.lang.String value)

Sets the value assigned to the linkAttributes attribute of the custom tag instance that uses this helper

Parameters:

value - String value that indicates the extra attributes to be added to the anchor tag.

Since:

MicroStrategy Web 8.0.0

setTitleID

public void setTitleID(java.lang.String value)

Sets the value assigned to the titleID attribute of the custom tag instance that uses this helper

Parameters:

value - String with the title id to be added.

Since:

MicroStrategy Web 9.0.0

getEvent

protected WebEvent getEvent()

Based on the eventID tag attribute, creates the event to use for this tag, considering the base bean (specified on the baseBean attribute.

Returns:

the WebEvent instance obtained, or null if no event could be generated.