public class

PageSetupHTMLEditorEventHandler

extends SysEventHandler
implements EnumAppComponentEvents EnumFrameEditorEvents
java.lang.Object
   ↳ com.microstrategy.web.beans.GenericEventHandler
     ↳ com.microstrategy.web.beans.SysEventHandler
       ↳ com.microstrategy.web.app.beans.PageSetupHTMLEditorEventHandler

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.beans.SysEventHandler
From class com.microstrategy.web.beans.GenericEventHandler
From interface com.microstrategy.web.app.beans.EnumAppComponentEvents
From interface com.microstrategy.web.app.beans.EnumFrameEditorEvents
From interface com.microstrategy.web.app.beans.EnumPageEvents
From interface com.microstrategy.web.app.beans.EnumServletEvents
From interface com.microstrategy.web.beans.WebEventTags
[Expand]
Inherited Fields
From class com.microstrategy.web.beans.GenericEventHandler
Public Constructors
PageSetupHTMLEditorEventHandler()
Public Methods
boolean handleApply(RequestKeys keys)
Handles apply event.
boolean processRequest(RequestKeys keys)
handle request as specified by the RequestKeys
void setWebComponent(WebComponent bean)
Extends setWebComponent by keeping a reference to a PageSetupHTMLEditorBean
Protected Methods
AppComponent getAppComponent()
String getArgumentValue(WebEvent event, int argID)
Utility method to obtain the value of a given event argument
int getCurrentEventID()
WebComponent getEditor()
boolean handleCancel(RequestKeys keys)
Handles Cancel event, which basically means close, so just calls the handleClose
boolean handleClose(RequestKeys keys)
Handles close event, asks the ReportFrameBean to close the editor.
boolean handleOk(RequestKeys keys)
Handles Ok event.
boolean handleOpen(RequestKeys keys)
Handles open event, asks the ReportFrameBean to open the editor.
boolean handleSetTopLeftPosition(RequestKeys keys)
Utility method for processing a location change request, by manipulating the top and left properties of the instance
[Expand]
Inherited Methods
From class com.microstrategy.web.beans.SysEventHandler
From class com.microstrategy.web.beans.GenericEventHandler
From class java.lang.Object
From interface com.microstrategy.web.beans.WebEventHandler

Public Constructors

public PageSetupHTMLEditorEventHandler ()

Public Methods

public boolean handleApply (RequestKeys keys)

Handles apply event. This event is abstract, each editor defines what does apply means to it.

Parameters
keys the RequestKeys
Returns
  • true if the apply was handled.
Throws
WebException if an exception is found.

public boolean processRequest (RequestKeys keys)

handle request as specified by the RequestKeys

Parameters
keys input request
Returns
  • true means some event is handled, false means nothing is handled
Throws
WebException if an exception is found.

public void setWebComponent (WebComponent bean)

Extends setWebComponent by keeping a reference to a PageSetupHTMLEditorBean

Parameters
bean WebComponent

Protected Methods

protected AppComponent getAppComponent ()

Returns

protected String getArgumentValue (WebEvent event, int argID)

Utility method to obtain the value of a given event argument

Parameters
event WebEvent to analyze
argID integer identifier of the argument to search for
Returns
  • String instance with the value of the requested event argument

protected int getCurrentEventID ()

Returns
  • integer value corresponding to the event currently being handled

protected WebComponent getEditor ()

Returns
  • WebComponent editor instance attached to this event handler

protected boolean handleCancel (RequestKeys keys)

Handles Cancel event, which basically means close, so just calls the handleClose

Parameters
keys the RequestKeys
Returns
  • true if cancel was handled.

protected boolean handleClose (RequestKeys keys)

Handles close event, asks the ReportFrameBean to close the editor.

Parameters
keys the RequestKeys
Returns
  • true if the editor was closed

protected boolean handleOk (RequestKeys keys)

Handles Ok event. Ok means apply and close, therefor this event first calls handleApply and then handleClose defines what does apply means to it.

Parameters
keys the RequestKeys
Returns
  • true if apply and close were handled.
Throws
WebException if an exception is found.

protected boolean handleOpen (RequestKeys keys)

Handles open event, asks the ReportFrameBean to open the editor.

Parameters
keys the RequestKeys
Returns
  • true if the editor was open

protected boolean handleSetTopLeftPosition (RequestKeys keys)

Utility method for processing a location change request, by manipulating the top and left properties of the instance

Parameters
keys RequestKeys from where the event, top and left information will be retrieved
Returns
  • boolean value indicating whether the request was processed successfully