java.lang.Object | |
↳ | com.microstrategy.web.app.beans.EventManager |
EventManager Provides utility functions related to WebEvent
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | DEFAULT_FORM_METHOD | Constant for specifying the default form method | |||||||||
String | DEFAULT_FORM_NAME | Constant for specifying the default form name | |||||||||
String | FORM_METHOD_GET | Constant for specifying the get form method | |||||||||
String | FORM_METHOD_POST | Constant for specifying the post form method | |||||||||
String | GLOBAL_LINK_CSS | Constant for specifying the default global css class for links |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
EventManager(WebComponent webComponent)
Class constructor.
| |||||||||||
EventManager(BeanContext beanContext)
Class constructor.
| |||||||||||
EventManager(AppContext appContext)
Class constructor.
| |||||||||||
EventManager(boolean useDhtml, boolean useIframe)
Simple class constructor.
| |||||||||||
EventManager(WebComponent webComponent, String extraURL, String extraInputs)
Class constructor
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String |
fixUrl(String url)
This method is deprecated.
use
fixUrl(ParameterBuilder) instead. | ||||||||||
void |
fixUrl(ParameterBuilder url)
Method for adjusting the
ParameterBuilder instance information for handling
environments where cookies are not supported. | ||||||||||
AnchorTag |
generateAnchor(WebEvent e)
Generate an
AnchorTag instance. | ||||||||||
Tag |
generateAnchor(WebEvent e, boolean enableIframe)
Generate an
AnchorTag instance. | ||||||||||
String |
generateDynamicEventLink(WebEvent event)
This method is deprecated.
use
getEventLink(WebEvent) instead.
| ||||||||||
Tag | generateForm(WebComponent bean, boolean enableIframe) | ||||||||||
Tag | generateForm() | ||||||||||
Tag | generateForm(WebComponent bean) | ||||||||||
void |
generateGetOpenFormForEvent(MarkupOutput mo, int indent, WebEvent event)
Generate an open form tag for an event
| ||||||||||
void |
generateIframeOpenAnchor(MarkupOutput mo, WebEvent e)
Generate an anchor for an IFrame event.
| ||||||||||
void |
generateIframeOpenAnchor(MarkupOutput mo, String url, String extraLink, String extraAttributes)
This method is deprecated.
use
generateAnchor(WebEvent) instead.
| ||||||||||
void |
generateIframeOpenAnchor(MarkupOutput mo, WebEvent e, boolean bSubmitForm)
Generates anchor for IFrame open event.
| ||||||||||
void |
generateIframeOpenFormForEvent(MarkupOutput mo, int indent, WebEvent event, String name, String method, boolean appendState)
Generate an open form tag for an IFrame event
| ||||||||||
void |
generateIframeOpenFormForEvent(MarkupOutput mo, int indent, String action, String name, String method, String extraLink, String extraAttributes)
Generate an open form tag for an IFrame event
| ||||||||||
void |
generateIframeOpenFormForEvent(MarkupOutput mo, int indent, WebEvent event, String name, String method, String extraLink, String extraAttributes, boolean appendState)
Generate an open form tag for an IFrame event
| ||||||||||
void |
generateIframeOpenFormForEvent(MarkupOutput mo, int indent, String action)
Generate an open form tag for an IFrame event
| ||||||||||
void |
generateIframeOpenFormForEvent(MarkupOutput mo, int indent, WebEvent event)
Generate an open form tag for an IFrame event
| ||||||||||
void |
generateIframeOpenFormForEvent(MarkupOutput mo, int indent, String action, String name, String method, String extraLink, String extraAttributes, boolean appendState)
Generate an open form tag for an IFrame event
| ||||||||||
void |
generateIframeOpenFormForEvent(MarkupOutput mo, int indent, WebEvent event, String name, String method)
Generate an open form tag for an IFrame event
| ||||||||||
void |
generateIframeOpenFormForEvent(MarkupOutput mo, int indent, String action, String name, String method)
Generate an open form tag for an IFrame event
| ||||||||||
void |
generateIframeOpenFormForEvent(MarkupOutput mo, int indent, String action, String name, String method, boolean appendState)
Generate an open form tag for an IFrame event
| ||||||||||
void |
generateOpenAnchor(StringBuffer sb, WebEvent e, int stateLevel, String extraLink, String extraAttributes)
This method is deprecated.
use
generateAnchor(WebEvent) instead.
| ||||||||||
void |
generateOpenAnchor(MarkupOutput mo, String url)
This method is deprecated.
use
generateAnchor(WebEvent) instead.
| ||||||||||
void |
generateOpenAnchor(StringBuffer sb, String url, String extraLink, String extraAttributes)
This method is deprecated.
use
generateAnchor(WebEvent) instead.
| ||||||||||
void |
generateOpenAnchor(MarkupOutput mo, String url, String extraLink, String extraAttributes)
This method is deprecated.
use
generateAnchor(WebEvent) instead.
| ||||||||||
void |
generateOpenAnchor(MarkupOutput mo, WebEvent e)
Generates an open anchor for an event.
| ||||||||||
void |
generateOpenAnchor(MarkupOutput mo, WebEvent e, int stateLevel, String extraLink, String extraAttributes)
This method is deprecated.
use
generateAnchor(WebEvent) instead.
| ||||||||||
void |
generateOpenAnchor(MarkupOutput mo, String url, boolean addDynamicState, String extraLink, String extraAttributes)
This method is deprecated.
use
generateAnchor(WebEvent) instead.
| ||||||||||
void |
generateOpenAnchor(MarkupOutput mo, WebEvent e, String extraLink, String extraAttributes)
This method is deprecated.
use
generateAnchor(WebEvent) instead.
| ||||||||||
void |
generateOpenFormForEvent(MarkupOutput mo, int indent, WebEvent event, String name, String method)
Generate an open form tag for an event
| ||||||||||
void |
generateOpenFormForEvent(MarkupOutput mo, int indent, String action)
Generate an open tag for a form.
| ||||||||||
void |
generateOpenFormForEvent(MarkupOutput mo, int indent, WebEvent event, String name, String method, String extraLink, String extraAttributes, boolean appendState)
Generate an open form tag for an event
| ||||||||||
void |
generateOpenFormForEvent(MarkupOutput mo, int indent, WebEvent event, String name, String method, boolean appendState)
Generate an open form tag for an event
| ||||||||||
void |
generateOpenFormForEvent(MarkupOutput mo, int indent, WebEvent event)
Generate an open form tag for an event
| ||||||||||
void |
generateOpenFormForEvent(MarkupOutput mo, int indent, String action, String name, String method, String extraLink, String extraAttributes)
Generate an open tag for a form.
| ||||||||||
void |
generateOpenFormForEvent(MarkupOutput mo, int indent, String action, String name, String method, boolean appendState)
Generate an open tag for a form.
| ||||||||||
void |
generateOpenFormForEvent(MarkupOutput mo, int indent, String action, String name, String method, String extraLink, String extraAttributes, boolean appendState)
Generate an open tag for a form.
| ||||||||||
void |
generateOpenFormForEvent(MarkupOutput mo, int indent, WebEvent event, String name, String method, String extraLink, String extraAttributes)
Generate an open form tag for an event
| ||||||||||
void |
generateOpenFormForEvent(MarkupOutput mo, int indent, String action, String name, String method)
Generate an open tag for a form.
| ||||||||||
String |
getEventLink(WebEvent e, int stateLevel)
Generate the link information according to the event provided as argument.
| ||||||||||
String |
getEventLink(WebEvent e)
Generate the link information according to the event provided as argument.
| ||||||||||
String |
getEventLink(WebEvent e, String extraUrl, int stateLevel)
Generate the link information according to the event provided as argument
| ||||||||||
String | getExtraInput() | ||||||||||
String | getExtraUrl() | ||||||||||
String |
getLinkCss()
This method is deprecated.
The css property should be specified after the anchor information tag has been generated.
| ||||||||||
boolean |
getUseCookie()
This method is deprecated.
- cookieless mode is no longer supported.
| ||||||||||
boolean |
isUseCss()
This method is deprecated.
The css property should be specified after the anchor information tag has been generated.
| ||||||||||
boolean | isUseIframe() | ||||||||||
void |
setExtraInput(String newValue)
Set any extra input information that shall be added to the forms generated by this instance
| ||||||||||
void |
setExtraUrl(String newValue)
Set any extra url information that shall be added to the links generated by this instance
| ||||||||||
void |
setLinkCss(String linkCss)
This method is deprecated.
The css property should be specified after the anchor information tag has been generated.
| ||||||||||
void |
setUseCss(boolean useCss)
This method is deprecated.
The css property should be specified after the anchor information tag has been generated.
| ||||||||||
void |
setUseDhtml(boolean useDhtml)
Specify if this instance should handle the links and forms as on a DHTML environment.
| ||||||||||
void |
setUseIframe(boolean useIframe)
Specify if this instance should handle the links and forms as on an iframe environment.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
NamespaceEncoder |
newNamespaceEncoder()
Convenience method to retrieve a new instance of a
NamespaceEncoder from the connected
ContainerServices object. | ||||||||||
ParameterBuilder |
newURIBuilder()
Convenience method to retrieve a new instance of a URI Builder from the connected
ContainerServices object. |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Constant for specifying the default form method
Constant for specifying the default form name
Constant for specifying the get form method
Constant for specifying the post form method
Constant for specifying the default global css class for links
Class constructor.
webComponent | WebComponent object from where to initialize
this instance.
|
---|
Class constructor.
beanContext | BeanContext object from where to initialize
this instance.
|
---|
Class constructor.
appContext | AppContext object from where to initialize
this instance.
|
---|
Simple class constructor.
useDhtml | boolean value indicating if the DHTML environment is enabled |
---|---|
useIframe | boolean value indicating if IFrames are enabled |
Class constructor
webComponent | WebComponent object from where to initialize
this instance. |
---|---|
extraURL | String value with any extra URL information to be added to the links generated by this manager |
extraInputs | String value with any extra inputs to be added to the form-related information generated by this manager |
This method is deprecated.
use fixUrl(ParameterBuilder)
instead.
Method for adjusting the url information for handling environments where cookies are not supported.
url | the original url information |
---|
Method for adjusting the ParameterBuilder
instance information for handling
environments where cookies are not supported.
url | ParameterBuilder instance to update |
---|
Generate an AnchorTag
instance.
e | WebEvent instance from where the anchor information will be initialized. |
---|---|
enableIframe | boolean value indicating if iframe shall be enabled for this anchor tag. |
AnchorTag
initialized instance, with link information as provided by the WebEvent
instance, if on DHTML environment then the child information will be submitted by an onclick
JavaScript method call to submitLink
or otherwise it will be their minimal state. If iframe is
enabled, then the target and url information will be adjusted accordingly.
This method is deprecated.
use getEventLink(WebEvent)
instead.
Generate the link information according to the event provided as argument.
event | WebEvent instance from where to obtain the information to generate as URL |
---|
bean | WebComponent instance to be used for initializing the form information. |
---|---|
enableIframe | boolean value indicating if the form will be working on an iframe environment or not. |
Tag
instance for a form HTML tag. The value for its method attribute will be
by default post
, for action it will be the root parent of the WebComponent
instance
provided as argument, if supporting iframes the target will be adjusted to the application's frameManager
and
if on DHTML environment, the child state will be added with the appendPageState
JavaScript
method.Tag
instance for a form HTML tag. The value for its method attribute will be
by default post
, for action it will be the root parent of the WebComponent
instance
used for initializing this event manager instance, by default it will not support iframes, but
if on DHTML environment, the child state will be added with the appendPageState
JavaScript
method.bean | WebComponent instance to be used for initializing the form information. |
---|
Tag
instance for a form HTML tag. The value for its method attribute will be
by default post
, for action it will be the root parent of the WebComponent
instance
provided as argument, by default it will not support iframes, but
if on DHTML environment, the child state will be added with the appendPageState
JavaScript
method.Generate an open form tag for an event
mo | MarkupOutput |
---|---|
indent | int |
event | WebEvent |
Generate an anchor for an IFrame event. By default it will not include
child state since this one will be handled by an onclick
call
to the submitLink
JavaScript method.
mo | MarkupOutput instance where the html output will be saved |
---|---|
e | WebEvent event for which the link will be generated
|
This method is deprecated.
use generateAnchor(WebEvent)
instead.
Generate an anchor for an iframe related event
mo | MarkupOutput instance where the html generated will be saved |
---|---|
url | String string with url information to use on the link |
extraLink | String extra arguments to add to the link |
extraAttributes | String extra attributes to add to the anchor |
Generates anchor for IFrame open event.
This is an overloaded function that takes an extra parameter for indicating not to submit HTML form.
It's required for some components such as Prompt's tree where selecting a hierarchy or Attribute doesn't
refresh IFrame.
mo | MarkupOutput instance where the html output will be saved |
---|---|
e | WebEvent event for which the link will be generated |
bSubmitForm | boolean true indicates to submit form with an onclick call
to the submitLink JavaScript method. |
Generate an open form tag for an IFrame event
mo | MarkupOutput |
---|---|
indent | int |
event | WebEvent |
name | String |
method | String |
appendState | boolean |
Generate an open form tag for an IFrame event
mo | MarkupOutput |
---|---|
indent | int |
action | String |
name | String |
method | String |
extraLink | String |
extraAttributes | String |
Generate an open form tag for an IFrame event
mo | MarkupOutput |
---|---|
indent | int |
event | WebEvent |
name | String |
method | String |
extraLink | String |
extraAttributes | String |
appendState | boolean |
Generate an open form tag for an IFrame event
mo | MarkupOutput |
---|---|
indent | int |
action | String |
Generate an open form tag for an IFrame event
mo | MarkupOutput |
---|---|
indent | int |
event | WebEvent |
Generate an open form tag for an IFrame event
mo | MarkupOutput |
---|---|
indent | int |
action | String |
name | String |
method | String |
extraLink | String |
extraAttributes | String |
appendState | boolean |
Generate an open form tag for an IFrame event
mo | MarkupOutput |
---|---|
indent | int |
event | WebEvent |
name | String |
method | String |
Generate an open form tag for an IFrame event
mo | MarkupOutput |
---|---|
indent | int |
action | String |
name | String |
method | String |
Generate an open form tag for an IFrame event
mo | MarkupOutput |
---|---|
indent | int |
action | String |
name | String |
method | String |
appendState | boolean |
This method is deprecated.
use generateAnchor(WebEvent)
instead.
Generates an open anchor.
sb | StringBuffer instance where the HTML output will be saved. |
---|---|
e | WebEvent instance from where to obtain the URL information to use for the anchor |
stateLevel | value from the EnumWebStateLevel enumeration indicating if or how much state information
should be included. |
extraLink | String value with any extra URL information to add to the anchor. |
extraAttributes | String with any extra attribute information to add to the anchor tag. |
This method is deprecated.
use generateAnchor(WebEvent)
instead.
Generates an open anchor.
mo | MarkupOutput instance where the HTML generated will be saved. |
---|---|
url | String value with the URL to define for the HREF attribute of the anchor |
This method is deprecated.
use generateAnchor(WebEvent)
instead.
Generate an open anchor tag.
sb | StringBuffer instance where the HTML output will be saved. |
---|---|
url | String with the url information to use on the anchor tag to generate |
extraLink | String value with any extra URL information to add to the anchor. |
extraAttributes | String with any extra attribute information to add to the anchor tag. |
This method is deprecated.
use generateAnchor(WebEvent)
instead.
Generates an open anchor.
mo | MarkupOutput instance where the HTML generated will be saved. |
---|---|
url | String value with the URL to define for the HREF attribute of the anchor. |
extraLink | String value with any extra URL information to add to the anchor. |
extraAttributes | String with any extra attribute information to add to the anchor tag. |
Generates an open anchor for an event. By default calls the generateAnchor(WebEvent)
method and gets the open tag for it.
mo | MarkupOutput instance where the html to generate will be saved |
---|---|
e | WebEvent event from where to generate the link
|
This method is deprecated.
use generateAnchor(WebEvent)
instead.
Generates an open anchor for an event.
mo | MarkupOutput instance where the html to generate will be saved |
---|---|
e | WebEvent event from where to generate the link |
stateLevel | value from the EnumWebStateLevel enumeration indicating if or how much state information
should be included. |
extraLink | String with any extra string information to add to the HREF attribute of the anchor |
extraAttributes | String with any extra attribute information to add to the anchor tag |
This method is deprecated.
use generateAnchor(WebEvent)
instead.
Generates an open anchor.
mo | MarkupOutput instance where the HTML generated will be saved. |
---|---|
url | String value with the URL to define for the HREF attribute of the anchor. |
addDynamicState | boolean value indicating if the state of the children should be added
dynamically as part of an onclick method call to the submitLink JavaScript method. |
extraLink | String value with any extra URL information to add to the anchor. |
extraAttributes | String with any extra attribute information to add to the anchor tag. |
This method is deprecated.
use generateAnchor(WebEvent)
instead.
Generates an open anchor for an event.
mo | MarkupOutput instance where the html to generate will be saved |
---|---|
e | WebEvent event from where to generate the link |
extraLink | String with any extra string information to add to the HREF attribute of the anchor |
extraAttributes | String with any extra attribute information to add to the anchor tag |
Generate an open form tag for an event
mo | MarkupOutput |
---|---|
indent | int |
event | WebEvent |
name | String |
method | String |
Generate an open tag for a form.
mo | MarkupOutput instance where the HTML content generated will be saved |
---|---|
indent | value for indentation consideration when generating the HTML |
action | String with the value to assign to the action attribute of the tag. |
Generate an open form tag for an event
mo | MarkupOutput |
---|---|
indent | int |
event | WebEvent |
name | String |
method | String |
extraLink | String |
extraAttributes | String |
appendState | boolean |
Generate an open form tag for an event
mo | MarkupOutput |
---|---|
indent | int |
event | WebEvent |
name | String |
method | String |
appendState | boolean |
Generate an open form tag for an event
mo | MarkupOutput |
---|---|
indent | int |
event | WebEvent |
Generate an open tag for a form.
mo | MarkupOutput instance where the HTML content generated will be saved |
---|---|
indent | value for indentation consideration when generating the HTML |
action | String with the value to assign to the action attribute of the tag. |
name | String with the name to assign to the form |
method | String with the method to use for the form (for example, post or get) |
extraLink | String with any extra value information to be added to the action attribute |
extraAttributes | String with any other extra attributes to be added to the tag definition |
Generate an open tag for a form.
mo | MarkupOutput instance where the HTML content generated will be saved |
---|---|
indent | value for indentation consideration when generating the HTML |
action | String with the value to assign to the action attribute of the tag. |
name | String with the name to assign to the form |
method | String with the method to use for the form (for example, post or get) |
appendState | boolean indicating if the child state should be appended to the form information using DHTML - provided DHTML is enabled. |
Generate an open tag for a form.
mo | MarkupOutput instance where the HTML content generated will be saved |
---|---|
indent | value for indentation consideration when generating the HTML |
action | String with the value to assign to the action attribute of the tag. |
name | String with the name to assign to the form |
method | String with the method to use for the form (for example, post or get) |
extraLink | String with any extra value information to be added to the action attribute |
extraAttributes | String with any other extra attributes to be added to the tag definition |
appendState | boolean indicating if the child state should be appended to the form information using DHTML - provided DHTML is enabled. |
Generate an open form tag for an event
mo | MarkupOutput |
---|---|
indent | int |
event | WebEvent |
name | String |
method | String |
extraLink | String |
extraAttributes | String |
Generate an open tag for a form.
mo | MarkupOutput instance where the HTML content generated will be saved |
---|---|
indent | value for indentation consideration when generating the HTML |
action | String with the value to assign to the action attribute of the tag. |
name | String with the name to assign to the form |
method | String with the method to use for the form (for example, post or get) |
Generate the link information according to the event provided as argument.
e | WebEvent instance from where to obtain the information to generate as URL |
---|---|
stateLevel | value from the EnumWebStateLevel enumeration indicating if or how much state information
should be included. |
stateLevel
argument.
Generate the link information according to the event provided as argument.
e | WebEvent instance from where to obtain the information to generate as URL |
---|
Generate the link information according to the event provided as argument
e | WebEvent instance from where to obtain the information to generate as URL |
---|---|
extraUrl | String value with any extra url information to add to the resulting link |
stateLevel | value from the EnumWebStateLevel enumeration indicating if or how much state information
should be included. |
This method is deprecated.
The css property should be specified after the anchor information tag has been generated.
Returns user defined CSS for the link. Will be used only if the useCSS is set to true
This method is deprecated.
- cookieless mode is no longer supported.
This method is deprecated.
The css property should be specified after the anchor information tag has been generated.
Returns whether to links generated will use the default cssClass ("mstrLink")
Set any extra input information that shall be added to the forms generated by this instance
newValue | String with the input information to add to the forms |
---|
Set any extra url information that shall be added to the links generated by this instance
newValue | String with the url information to add to the links |
---|
This method is deprecated.
The css property should be specified after the anchor information tag has been generated.
Defines user defined CSS for the link. Will be used only if the useCSS is set to true
linkCss | CSS for the link |
---|
This method is deprecated.
The css property should be specified after the anchor information tag has been generated.
Defines whether to use the default cssClass ("mstrLink") when generating the link
useCss | true if the link should use the "mstrLink" class |
---|
Specify if this instance should handle the links and forms as on a DHTML environment.
useDhtml | boolean value indicating if DHTML is handled by this instance or not. |
---|
Specify if this instance should handle the links and forms as on an iframe environment.
useIframe | boolean value indicating if iframes are handled by this instance or not. |
---|
Convenience method to retrieve a new instance of a NamespaceEncoder
from the connected
ContainerServices
object. If anything fails along the way, returns a null object.
NamespaceEncoder
instance to use for encoding names.Convenience method to retrieve a new instance of a URI Builder from the connected
ContainerServices
object. If anything fails along the way, returns a null object.
ParameterBuilder
instance to use for building URIs.