public class

MySubscriptionsPageComponentImpl

extends AbstractPersistableAppComponent
implements PageComponent

java.lang.Object
↳	com.microstrategy.utils.serialization.AbstractPersistable
	↳	com.microstrategy.web.beans.AbstractTransformable
		↳	com.microstrategy.web.beans.AbstractWebComponent
			↳	com.microstrategy.web.app.beans.AbstractAppComponent
				↳	com.microstrategy.web.app.beans.AbstractPersistableAppComponent
					↳	com.microstrategy.web.app.beans.MySubscriptionsPageComponentImpl

Class Overview

Specialized implementation of the page component used for the "My Subscriptions" page.

Summary

[Expand]

Inherited Constants

From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

From interface com.microstrategy.web.app.beans.AppComponent

From interface com.microstrategy.web.app.beans.PageComponent

Fields
protected PageInfo	_page
protected String	_title
protected String	_titleId

[Expand]

Inherited Fields

From class com.microstrategy.web.beans.AbstractWebComponent

From class com.microstrategy.web.beans.AbstractTransformable

From class com.microstrategy.utils.serialization.AbstractPersistable

Public Constructors
	MySubscriptionsPageComponentImpl()

Public Methods
void	cleanUp() Performs any necessary clean up tasks before leaving the page.
void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
void	collectMinimalData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
boolean	executeCollectDataRequiredAddons(WebComponent wc) Checks if the different addons associated with the WebComponent require a collect data to be performed.
void	executePostCollectDataAddons() Executes the post collect data addons on the page in the order in which they appear in the pageconfig file.
void	executePreCollectDataAddons() Executes the addons on the page in the order in which they appear in the pageconfig file.
MarkupOutput	generateOutput() Generates the output of a bean.
ContextMenuManager	getContextMenuManager() This method is deprecated. This method is not used by the application and will be removed in future versions.
int	getDebugFlags() Get the decimal-format debug flags from the page
MarkupOutput	getDebugOut(int debugFlags) Get the Debug Information into the output
AppBeanError	getErrorInfo() Returns the last `AppBeanError` set to this page.
int	getExplicitScreenMode()
WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
String	getFontName() Returns a string with the name of the fonts, or the list of fonts that a browser should use when rendering the page.
String	getFontSize() A string with the base font size to use, the string might contain the type of size (i.e, pt, px, etc.)
int	getLastMessageKey() Read message key for active session.
String	getLastMsgID()
String	getPageHistoryKey()
PageInfo	getPageInfo()
String	getRedirectURL() Returns the URL to be send down to the browser that corresponds to the page.
PageResourceManager	getResourceManager() Returns the instance of the `PageResourceManager` associated with the page.
int	getResourceManagerMode() Returns the mode of the page manager set up on the page component.
int	getScreenMode() Return the current page screen mode.
String	getTemplateFileName() Returns the name of a template file to redirect
TemplateInfo	getTemplateInfo() Convenience method.
String	getTitle() Returns the pages's title.
String	getTitleDescriptorId()
WebIServerSession	getWebIServerSession()
String	getXMLStatusPageName() Returns the name of the page in the Page Framework that will be displayed for the current page and xml status combination.
boolean	hasBinaryContent()
boolean	hasXMLStatusPage() Returns true if a page in the Page Framework will be displayed for the current page and xml status combination.
boolean	isOpen() Returns a boolean value indicating if the instance is marked as opened or closed.
boolean	isRedirect() Indicates if the page will be sent down as a redirect response (HTTP 302) instead of an ok response (HTTP 200)
boolean	isRestoredFromPageHistory()
boolean	isStagePage() Returns true if this page is just a stage page which acts as a bridge between two pages.
void	persistBeans() For each one of the beans defined, saves their State through the StateManager for future use in this page.
void	processApplyChanges(String pageName) The method will be responsible for executing the apply events to those beans that require to so, when the page is about to change
void	saveLastPage() Saves the information of the last succesful page so it can be restored by the cancel event.
void	saveReturnToPage(int mode) Saves the information of the last visited page so it can be restored by the returnTo event.
void	setChanged(boolean value) Sets the changed state of the component
void	setErrorInfo(AppBeanError error) Associates an `AppBeanError` with the page.
void	setExplicitScreenMode(int screenMode) Use to set the explicit screen mode.
void	setIsRedirect(boolean redirect) Sets the page as a redirect response (HTTP 302) instead of an ok response (HTTP 200)
void	setPageInfo(PageInfo page) This method sets the current Page (the object with the current Page structure)
void	setRestoredFromPageHistory(boolean value)
void	setScreenMode(int screenMode) Set the screenMode of the page.
void	setStagePage(boolean isStagePage) Sets the page as a stage page which acts as a bridge between two pages.
void	setTemplateFileName(String value) Sets the name of a template file to redirect
void	setTitle(String title) Define the alias that the page will display when called.
void	setWebIServerSession(WebIServerSession session) This method is deprecated. The method does not have any effect in the object
void	switchPage(String pageName, ServletWebComponent servletWebComponent) Replaces the current page in the Servlet with the indicated page

Protected Methods
void	doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer) Proceses the save/restore state opperation of the AppComponent
void	doSaveToPageHistory() Saves the page of to the page history regardless of the status or isTrack()
PageHistoryList	getPageHistoryList()
WebEventHandler	newDefaultEventHandler()
void	saveToPageHistory() Saves the information of the last visited page so it can be restored by open history list page event.
void	setObjectBeanPageTitle(ObjectBean bean)

[Expand]

Inherited Methods

From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

From class com.microstrategy.web.app.beans.AbstractAppComponent

void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
void	collectMinimalData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
boolean	compareChildsTargetWithCurrent() The implementing class should implement this method to return true if it wants to always call the current object's targetBean#hasChanged method in #hasTargetBeanChanged method.
TransformInstance	createTransformInstance(Transform transform)
void	doCollectData() Call the required methods so the data is collected for this instance
void	doCollectMinimalData() By default this method simply invokes `doCollectData()`, i.e.
MarkupOutput	generateOutput() Generates the output of a bean.
AppContext	getAppContext() This method returns the application context object associated with this component.
String	getContactInfo() This method is deprecated. Use Preferences.getValue(EnumWebPreferences.WebPreferenceAdminInfo) instead.
ContainerServices	getContainerServices() Convenience method to retrieve the connected Container Services object.
String	getDescriptor(int key) Retrieve the descriptor when the key is an integer value...
String	getDescriptor(String key) Retrieve the descriptor when the key is a string
EventManager	getEventManager() This method returns the application EventManager used to generates events.
String	getExtraInput() Get any extra input form information to be used when generating form information on the transforms associated with this instance.
String	getExtraUrl() Get any extra url information to be used when generating link information on the transforms associated with this instance.
WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
int	getLeft() Get the left position where the bean should be displayed by the transform if applicable
WebObjectSource	getObjectSource()
int	getResultFilterMode()
WebIServerSession	getSession()
WebComponent	getTargetBean() Get the target bean associated with this instance
int	getTop() Get the top position where the bean should be displayed by the transform if applicable
int	getType() Returns the transformable type as in `EnumWebTransformableType`.
static WebObjectsFactory	getWebObjectsFactory(WebBean wb) Utility method for obtaining a `WebObjectsFactory` instance
WebObjectsFactory	getWebObjectsFactory()
int	getXMLStatus() Returns the `EnumRequestStatus` status of the component.
boolean	hasChanged() Verifies the state of the component has changed
boolean	hasTargetBeanChanged() When this method is called, we have already checked the children and each of the children has returned with hasChanged() as false.
boolean	haveChildrenChanged()
WebComponent	initComponent(WebComponent bean, String suffix) Initialize a WebComponent as child of this FrameBean.
void	internalCollectData() This method is called internally by the transform() method to ensure collectData has been triggered and the bean is ready to transform.
boolean	isDialog() Returns true if this bean should be treated as a dialog
boolean	isForcedChildrenStateSaving() Return wheter the bean's children will be save their states or not despite it's open or closed state.
boolean	isIFrameRequest() Utility method that determines if it's an IFrame type of request.
boolean	isModal() The property is used to determine wheter the component will be displayed as a floating (popup) dialog with modal property.
boolean	isModalOpen() indicates whether there is a Modal AppComponent open in the hierarchy
boolean	isOpen() Returns a boolean value indicating if the instance is marked as opened or closed.
BeanContext	newDefaultBeanContext() This method is called by getBeanContext() to automatically create an instance of a BeanContext if one has not been explicitly set.
ParameterBuilder	newHiddenInputBuilder() Convenience method to retrieve a new instance of a Hidden Input Builder from the connected Container Services object.
NamespaceEncoder	newNamespaceEncoder() Convenience method to retrieve a new instance of a Namespace Encoder from the connected Container Services object.
StyleRequestContext	newStyleRequestContext()
ParameterBuilder	newURIBuilder() Convenience method to retrieve a new instance of a URI Builder from the connected Container Services object.
void	setExtraInput(String newValue) Set any extra input form information to be used when generating form information on the transforms associated with this instance.
void	setExtraUrl(String newValue) Set any extra url information to be used when generating link information on the transforms associated with this instance.
void	setForcedChildrenStateSaving(boolean value) Forces the bean to propagate its children to save state despite it's open or closed state.
void	setHasJustOpened(boolean value) Sets whether the component has just been opened.
void	setIsDialog(boolean value) Set method for defining if the instance is to be defined as a Dialog or not.
void	setIsModal(boolean value) Set method for defining if the instance is to be defined as a Modal interface or not.
void	setIsOpen(boolean value) Set the current instance as opened.
void	setLeft(int x) Set the left position where the bean should be displayed by the transform if applicable.
void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` for the current WebComponent.
void	setTop(int y) Set the top osition where the bean should be displayed by the transform if applicable.

From class com.microstrategy.web.beans.AbstractWebComponent

From class com.microstrategy.web.beans.AbstractTransformable

From class com.microstrategy.utils.serialization.AbstractPersistable

void	doFlatState(FlatStateSerializer ser, int howMuchState, FlatStateTokenizer tok, int stateFlag)
void	doFlatState(FlatStateSerializer ser, int howMuchState, FlatStateTokenizer tok)
AbstractHandler	getStateHandler()
boolean	isXMLStateZipped()
boolean	restoreState(SAXSupport parser, String uri, String localName, String qName, Attributes attrs) Restores a component from an embedded XML during a SAX parsing.
boolean	restoreState(String state) Restores a component based on its saved state.
void	restoreXMLState(String state)
String	saveState() Returns a `java.lang.String` representation of a component.
void	saveState(StringBuffer buf, int howMuchState, int stateFlag) Saves and stores a component's state into a `StringBuffer`.
void	saveState(StringBuffer buf, int howMuchState) Saves and stores a component's state into a `StringBuffer`.
String	saveState(int howMuchState) Returns a `java.lang.String` representation of a component.
void	saveXMLState(StringBuffer buf, int howMuchState, int stateFlag)
void	saveXMLState(StringBuffer buf, int howMuchState)

From class java.lang.Object

From interface com.microstrategy.utils.serialization.Persistable

From interface com.microstrategy.web.app.beans.AppComponent

abstract AppContext	getAppContext() This method returns the application context object associated with this component.
abstract String	getDescriptor(String key) Retrieve the descriptor when the key is a string
abstract String	getDescriptor(int key) Retrieve the descriptor when the key is an integer value...
abstract EventManager	getEventManager() This method returns the application EventManager used to generates events.
abstract String	getExtraInput() Get any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract String	getExtraUrl() Get any extra url information to be used when generating link information on the transforms associated with this instance.
abstract int	getLeft() Get the left position where the bean should be displayed by the transform if applicable
abstract int	getResultFilterMode()
abstract int	getTop() Get the top position where the bean should be displayed by the transform if applicable
abstract boolean	isDialog() Returns true if this bean should be treated as a dialog
abstract boolean	isForcedChildrenStateSaving() Return whether the state will be save despite it's open or closed state.
abstract boolean	isModal() Retrieves the modal state of the bean
abstract boolean	isModalOpen() indicates whether there is a Modal AppComponent open in the hierarchy
abstract boolean	isOpen() Retrieves the open/close state of the bean
abstract void	setExtraInput(String newValue) Set any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract void	setExtraUrl(String newValue) Set any extra url information to be used when generating link information on the transforms associated with this instance.
abstract void	setForcedChildrenStateSaving(boolean value) Forces the bean state to be save despite it's open or closed state.
abstract void	setHasJustOpened(boolean value) Sets whether the component has just been opened.
abstract void	setIsDialog(boolean value) Sets the bean to its dialog mode.
abstract void	setIsModal(boolean value) Sets the bean to its modal mode.
abstract void	setIsOpen(boolean value) Sets the bean to its enabled mode, meaning the editor will be visible to the user
abstract void	setLeft(int x) Set the left position where the bean should be displayed by the transform if applicable.
abstract void	setTop(int y) Set the top position where the bean should be displayed by the transform if applicable.

From interface com.microstrategy.web.app.beans.PageComponent

abstract void	cleanUp() Performs any necessary clean up tasks before leaving the page.
abstract boolean	executeCollectDataRequiredAddons(WebComponent wc) Checks if the different addons associated with the `WebComponent` require a collect data to be performed.
abstract void	executePostCollectDataAddons() Executes the post collect data addons on the page in the order in which they appear in the pageconfig file.
abstract void	executePreCollectDataAddons() Executes the addons on the page in the order in which they appear in the pageconfig file.
abstract String	getContactInfo() Returns the administrator contact info for this application.
abstract ContextMenuManager	getContextMenuManager() This method is deprecated. This method is not used by the application and will be removed in future versions.
abstract int	getDebugFlags() Get the decimal-format debug flags from the page
abstract MarkupOutput	getDebugOut(int debugFlags) Get the Debug Information into the output
abstract AppBeanError	getErrorInfo() Returns the last `AppBeanError` set to this page.
abstract int	getExplicitScreenMode()
abstract String	getFontName() Returns a string with the name of the fonts, or the list of fonts that a browser should use when rendering the page.
abstract String	getFontSize() A string with the base font size to use, the string might contain the type of size (i.e, pt, px, etc.)
abstract int	getLastMessageKey()
abstract String	getLastMsgID()
abstract PageInfo	getPageInfo()
abstract String	getRedirectURL() Returns the URL to be send down to the browser that corresponds to the page.
abstract PageResourceManager	getResourceManager() Returns the instance of the `PageResourceManager` associated with the page.
abstract int	getResourceManagerMode() Returns the mode of the page manager set up on the page component.
abstract int	getScreenMode() Return the current page screen mode.
abstract String	getTemplateFileName() Returns the name of a template file to redirect
abstract TemplateInfo	getTemplateInfo() Returns the `TemplateInfo` to use with this page
abstract String	getTitle() Returns the pages's title.
abstract WebIServerSession	getWebIServerSession()
abstract String	getXMLStatusPageName() Returns the name of the page in the Page Framework that will be displayed for the current page and xml status combination.
abstract boolean	hasBinaryContent()
abstract boolean	hasXMLStatusPage() Returns true if a page in the Page Framework will be displayed for the current page and xml status combination.
abstract boolean	isRedirect() Indicates if the page will be sent down as a redirect response (HTTP 302) instead of an ok response (HTTP 200)
abstract boolean	isRestoredFromPageHistory()
abstract boolean	isStagePage() Returns true if this page is just a stage page which acts as a bridge between two pages.
abstract void	processApplyChanges(String pageName) The method will be responsible for executing the apply events to those beans that require to so, when the page is about to change
abstract void	saveLastPage() Saves the information of the last succesful page so it can be restored by the cancel event.
abstract void	saveReturnToPage(int mode) Saves the information of the last visited page so it can be restored by the returnTo event.
abstract void	setErrorInfo(AppBeanError error) Associates an `AppBeanError` with the page.
abstract void	setExplicitScreenMode(int screenMode) Use to set the explicit screen mode.
abstract void	setIsRedirect(boolean redirect) Sets the page as a redirect response (HTTP 302) instead of an ok response (HTTP 200)
abstract void	setPageInfo(PageInfo page) This method sets the current `PageInfo` (the object with the current Page structure).
abstract void	setRestoredFromPageHistory(boolean value)
abstract void	setScreenMode(int screenMode) Set the screenMode of the page.
abstract void	setStagePage(boolean isStagePage) Sets the page as a stage page which acts as a bridge between two pages.
abstract void	setTemplateFileName(String value) Sets the name of a template file to redirect
abstract void	setTitle(String title) Define the alias that the page will display when called.
abstract void	setWebIServerSession(WebIServerSession session)
abstract void	switchPage(String pageName, ServletWebComponent servletWebComponent) Replaces the current page in the Servlet with the indicated page

From interface com.microstrategy.web.beans.RequestPersistable

From interface com.microstrategy.web.beans.Transformable

From interface com.microstrategy.web.beans.WebComponent

abstract void	addChild(String key, WebComponent child) adds a child WebComponent instance on the current WebComponent.
abstract void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	addChildStateInfo(ParameterBuilder paramBldr, int howMuchState) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
abstract void	collectMinimalData() This is similar to `collectData()` except data collected is minimal.
abstract MarkupOutput	generateOutput() This is the generic method to ask the WebComponent to generate some output for the client.
abstract BeanContext	getBeanContext() Returns an instance of `BeanContext`.
abstract WebComponent	getChild(String key) Returns the child WebComponent instance specified by the key.
abstract WebComponent	getChild(int index) Returns the child WebComponent instance specified by the index.
abstract WebComponent	getChildByClass(Class className) Returns the child WebComponent instance specified by the class.
abstract WebComponent	getChildByType(int childType) Returns the child WebComponent instance specified by the component type(`EnumWebTransformableType`).
abstract int	getChildCount() Returns the total number of children on the current WebComponent.
abstract void	getChildrenByClass(Class className, HashList retList, boolean recursive) Returns a collection of children specified by the class name
abstract int	getDefaultStateLevel() Returns the default state level for the WebComponent.
abstract WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
abstract int	getMaximumStateLevel() Returns the maximum state level that is supported by the WebComponent.
abstract String	getName() Returns the name of the current WebComponent.
abstract int	getOutputFormat() Returns the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract WebComponent	getParent() Returns the parent WebComponent of the current WebComponent.
abstract String	getPath() Returns the path from the root WebComponent to the current WebComponent.
abstract int	getPersistMode() Returns the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract Set	getRenderingFilter() returns the rendering filter.
abstract WebComponent	getRoot() Returns the root of the current WebComponent.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract WebEvent	getWebEvent(int event, boolean recurse) Returns the `WebEvent` instance with the specified event ID.
abstract WebEvent	getWebEvent(int event) Returns the `WebEvent` instance with the specified event ID.
abstract WebEventHandler	getWebEventHandler() Returns the `WebEventHandler` instance associated with the current WebComponent.
abstract int	getXMLStatus() This method returns the `EnumRequestStatus` status of the current Component.
abstract boolean	handleRequest(RequestKeys keys) Handles a request.
abstract boolean	hasChanged() Verifies the state of the component has changed
abstract boolean	hasJustOpened() Verifies if the component has just been opened.
abstract void	initBean() Initialize the component after it's created and its properties initialized
abstract void	invalidateChildrenState() Invalidates the cached URL and hidden INPUT states of all the components, including the current component, along the path to the root component.
abstract boolean	isBeanContextEmpty() Verifies if a bean context exists for the current WebComponent.
abstract boolean	isFeatureAvailable(String featureID) Verifies the feature provided is accesible based on the properties of this WebComponent
abstract void	prepareForReuse() If a Web Component instance is going to be reused across different requests, this API serves as a notifier to the component to do the necessary cleanup.
abstract WebComponent	removeChild(String key) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	removeChild(WebComponent component) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	searchChild(String key) Returns the child WebComponent instance specified by the key.
abstract void	setBeanContext(BeanContext beanContext, boolean propagate) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setBeanContext(BeanContext beanContext) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setChanged(boolean value) Sets the changed state of the component.
abstract void	setChanged(boolean value, boolean forceRecurse) Sets the changed state of the component
abstract void	setDefaultStateLevel(int stateLevel) Sets the default state level for the WebComponent.
abstract void	setFeaturesManager(WebFeatures featuresManager) Associate a WebFeatures implementation with this WebComponent
abstract void	setName(String name) Sets the name on the current WebComponent.
abstract void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract void	setParent(WebComponent parent) Sets the parent WebComponent of the current WebComponent.
abstract void	setPersistMode(int persistFlag) Sets the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract void	setRenderingFilter(Set renderingFilter) Sets the list of beans to render.
abstract void	setTargetBean(WebComponent bean) Set the target bean that will be associated with this instance.
abstract void	setTargetBeanPath(String beanName) Define the base bean for this instance.
abstract void	setWebEventHandler(WebEventHandler handler) Sets a `WebEventHandler` on this component.

Fields

protected PageInfo _page

protected String _title

protected String _titleId

Public Constructors

public MySubscriptionsPageComponentImpl ()

Public Methods

public void cleanUp ()

Performs any necessary clean up tasks before leaving the page.
Called when event WebEventOpenHistoryPage is submited

public void collectData ()

Triggers execution to the back end no matter whether it is synchronous or asynchronous. This implementation also trigger the addons execution before and after the collect data.

Throws

WebBeanException

public void collectMinimalData ()

Triggers execution to the back end no matter whether it is synchronous or asynchronous. If this method fails to collect data, an exception is raised and saved in a WebBeanError instance. If isOpen(), this method will first perform a doCollectMinimalData(), then proceeds to call collectMinimalData() on all child components getChild(int).

Throws

WebBeanException

public boolean executeCollectDataRequiredAddons (WebComponent wc)

Checks if the different addons associated with the WebComponent require a collect data to be performed.

Parameters

wc	WebComponent instance that will have its addon methods called

Returns

boolean value indicating if the collectData is required or not

public void executePostCollectDataAddons ()

Executes the post collect data addons on the page in the order in which they appear in the pageconfig file.

public void executePreCollectDataAddons ()

Executes the addons on the page in the order in which they appear in the pageconfig file.

public MarkupOutput generateOutput ()

Generates the output of a bean. It transforms the bean

Returns

Null for this component.

public ContextMenuManager getContextMenuManager ()

This method is deprecated.
This method is not used by the application and will be removed in future versions.

Returns

The Page's ContextMenuManager

public int getDebugFlags ()

Get the decimal-format debug flags from the page

public MarkupOutput getDebugOut (int debugFlags)

Get the Debug Information into the output

Returns

an instance of MarkupOutput.

public AppBeanError getErrorInfo ()

Returns the last AppBeanError set to this page. If no errors have been associated to this page it returns null.

Returns

the AppBeanError associated with the execution of the page.

public int getExplicitScreenMode ()

public WebFeatures getFeaturesManager ()

Return the WebFeatures implementation associated with this WebComponent

Returns

a WebFeatures instance

public String getFontName ()

Returns a string with the name of the fonts, or the list of fonts that a browser should use when rendering the page. This is usually retrieved from user Preferences

Returns

a String with a comma separated list of the fonts to use in this page.

public String getFontSize ()

A string with the base font size to use, the string might contain the type of size (i.e, pt, px, etc.)

Returns

a string with size of the font to use

public int getLastMessageKey ()

Read message key for active session.

Returns

{int}

public String getLastMsgID ()

public String getPageHistoryKey ()

Returns

a key unique to the page used for the page history.

public PageInfo getPageInfo ()

Returns

the current Page (that holds the Page structure)

public String getRedirectURL ()

Returns the URL to be send down to the browser that corresponds to the page.

Returns

a URL String

public PageResourceManager getResourceManager ()

Returns the instance of the PageResourceManager associated with the page. Returns null if the resource manager is disabled.

Returns

instance of PageResourceManager

public int getResourceManagerMode ()

Returns the mode of the page manager set up on the page component. The values are defined in the PageResourceManager class

Returns

positive integer when it is enabled.

public int getScreenMode ()

Return the current page screen mode.

Returns

page screen mode.

public String getTemplateFileName ()

Returns the name of a template file to redirect

Returns

a file name.

public TemplateInfo getTemplateInfo ()

Convenience method. Equivalent to calling: getPageInfo.getTemplateInfoList().getTemplateInfo(getXMLStatus())

Returns

the current templateinfo to be used by this page

public String getTitle ()

Returns the pages's title. This method dynamically sets the title of the page, depending on:

If the user has set title using the setTitle(String) method, that title is used.
If the first child of the page is of any of the expected types, the title is used based on the bean.
If the PageInfo contains a desc-id, the resource associated with the desc-id is used
If the PageInfo contains a description, the description is used
The name of the page.

Returns

The title of this page

public String getTitleDescriptorId ()

public WebIServerSession getWebIServerSession ()

Returns

The WebIServerSession used by this page. If this page is not using a session, it returns null;

public String getXMLStatusPageName ()

Returns the name of the page in the Page Framework that will be displayed for the current page and xml status combination. This is defined at the template level in the pageConfig.xml file

Returns

String. Page Name from pageConfig.xml

public boolean hasBinaryContent ()

Returns

true if the page would generate binary content in it's output

public boolean hasXMLStatusPage ()

Returns true if a page in the Page Framework will be displayed for the current page and xml status combination. This is defined at the template level in the pageConfig.xml file

Returns

true is a page Name has been defined in pageConfig.xml

public boolean isOpen ()

Returns a boolean value indicating if the instance is marked as opened or closed.

Returns

boolean value of True if the instance is marked as opened, it will return False otherwise. By default, instances not marked as dialogs (isDialog() property returning False) will have a browser setting associated with them that should indicate if they are opened or closed. The parent hierarchy is also tested to be in opened state as well as dependent beans not to be in error.

public boolean isRedirect ()

Indicates if the page will be sent down as a redirect response (HTTP 302) instead of an ok response (HTTP 200)

Returns

boolean value indicating if the the page will be displayed as a redirect (HTTP 302) response

public boolean isRestoredFromPageHistory ()

public boolean isStagePage ()

Returns true if this page is just a stage page which acts as a bridge between two pages.

Returns

true is this page is a stage page.

public void persistBeans ()

For each one of the beans defined, saves their State through the StateManager for future use in this page.

public void processApplyChanges (String pageName)

The method will be responsible for executing the apply events to those beans that require to so, when the page is about to change

Parameters

pageName	The name of the new page

Throws

	WebException
WebException

public void saveLastPage ()

Saves the information of the last succesful page so it can be restored by the cancel event.

public void saveReturnToPage (int mode)

Saves the information of the last visited page so it can be restored by the returnTo event.

Parameters

mode	`int` value indicating the type of action that should be performed about the return to page information. Values include`STORE_PAGE` and `REMOVE_PAGE`.

public void setChanged (boolean value)

Sets the changed state of the component

Parameters

value	a boolean value indicating whether the component is changed.

public void setErrorInfo (AppBeanError error)

Associates an AppBeanError with the page. If an error occurred during the page initialization/execution, this error should be set. It's responsibility of the display later (i.e., the JSP) to display this error to the end user.

Parameters

error	The last error on this page. `null` if none happened

public void setExplicitScreenMode (int screenMode)

Use to set the explicit screen mode.

public void setIsRedirect (boolean redirect)

Sets the page as a redirect response (HTTP 302) instead of an ok response (HTTP 200)

Parameters

redirect	`boolean` value indicating if the the page will be displayed as a redirect (HTTP 302) response

public void setPageInfo (PageInfo page)

This method sets the current Page (the object with the current Page structure)

Parameters

page	Page object

public void setRestoredFromPageHistory (boolean value)

public void setScreenMode (int screenMode)

Set the screenMode of the page. Screen mode can be normal screen mode (screenMode = 1), full screen mode (screenMode = 2), or default to normal screen mode (screenMode = 0).

public void setStagePage (boolean isStagePage)

Sets the page as a stage page which acts as a bridge between two pages.

Parameters

isStagePage	`boolean` value indicating if the the page is a stagePage.

public void setTemplateFileName (String value)

Sets the name of a template file to redirect

Parameters

value	`String` value indicating the template file name to use.

public void setTitle (String title)

Define the alias that the page will display when called.

Parameters

title	String with the title of the page. User setTitle

public void setWebIServerSession (WebIServerSession session)

This method is deprecated.
The method does not have any effect in the object

Parameters

session	The WebIServerSession to be used by this page.

public void switchPage (String pageName, ServletWebComponent servletWebComponent)

Replaces the current page in the Servlet with the indicated page

Throws

WebBeanException
WebException

Protected Methods

protected void doFlatState (FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)

Proceses the save/restore state opperation of the AppComponent

Parameters

serializer	an instance of the FlatStateSerializer object to use
howMuchState	defines how much information needs to be saved
tokenizer	an instance of the FlatStateTokenizer object to use

protected void doSaveToPageHistory ()

Saves the page of to the page history regardless of the status or isTrack()

protected PageHistoryList getPageHistoryList ()

Returns

the page history list object

protected WebEventHandler newDefaultEventHandler ()

protected void saveToPageHistory ()

Saves the information of the last visited page so it can be restored by open history list page event.
Uses the page's status and the pages isTrack() to determine whether to save the page

Interfaces

Classes

Exceptions

MySubscriptionsPageComponentImpl

Class Overview

Summary

Fields

protected PageInfo _page

protected String _title

protected String _titleId

Public Constructors

public MySubscriptionsPageComponentImpl ()

Public Methods

public void cleanUp ()

public void collectData ()

Throws

public void collectMinimalData ()

Throws

public boolean executeCollectDataRequiredAddons (WebComponent wc)

Parameters

Returns

public void executePostCollectDataAddons ()

public void executePreCollectDataAddons ()

public MarkupOutput generateOutput ()

Returns

public ContextMenuManager getContextMenuManager ()

Returns

public int getDebugFlags ()

public MarkupOutput getDebugOut (int debugFlags)

Returns

public AppBeanError getErrorInfo ()

Returns

public int getExplicitScreenMode ()

public WebFeatures getFeaturesManager ()

Returns

public String getFontName ()

Returns

public String getFontSize ()

Returns

public int getLastMessageKey ()

Returns

public String getLastMsgID ()

public String getPageHistoryKey ()

Returns

public PageInfo getPageInfo ()

Returns

public String getRedirectURL ()

Returns

public PageResourceManager getResourceManager ()

Returns

public int getResourceManagerMode ()

Returns

public int getScreenMode ()

Returns

public String getTemplateFileName ()

Returns

public TemplateInfo getTemplateInfo ()

Returns

public String getTitle ()

Returns

public String getTitleDescriptorId ()

public WebIServerSession getWebIServerSession ()

Returns

public String getXMLStatusPageName ()

Returns

public boolean hasBinaryContent ()

Returns

public boolean hasXMLStatusPage ()

Returns

public boolean isOpen ()

Returns

See Also

public boolean isRedirect ()

Returns

public boolean isRestoredFromPageHistory ()

public boolean isStagePage ()

Returns

public void persistBeans ()

public void processApplyChanges (String pageName)

Parameters