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.CSRFConfirmationPageComponentImpl
        
        com.microstrategy.web.app.beans.SharingConfirmationPageComponentImpl

All Implemented Interfaces:

EnumWebPersistableState, Persistable, AppComponent, PageComponent, RequestPersistable, Transformable, WebComponent
```
public class SharingConfirmationPageComponentImpl
extends CSRFConfirmationPageComponentImpl
```

Field Summary

Fields
Modifier and Type Field Description

protected PageInfo _page

protected java.lang.String _title

protected java.lang.String _titleId
- Fields inherited from class com.microstrategy.web.app.beans.AbstractPersistableAppComponent
  STATE_DELIMITOR, STATE_ITEM_SEPARATOR
- Fields inherited from class com.microstrategy.web.beans.AbstractWebComponent
  _features, _hasJustOpened
- Fields inherited from class com.microstrategy.web.beans.AbstractTransformable
  _beanContext
- Fields inherited from class com.microstrategy.utils.serialization.AbstractPersistable
  scriptEndTagEncoder
- Fields inherited from interface com.microstrategy.web.app.beans.AppComponent
  COMPONENT_POSITION_NOT_INITIALIZED
- Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
  BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO
- Fields inherited from interface com.microstrategy.web.app.beans.PageComponent
  REMOVE_PAGE, STORE_PAGE

Constructor Summary

Constructors
Constructor Description

SharingConfirmationPageComponentImpl()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`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.
`protected void`	`doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)`	Proceses the save/restore state opperation of the AppComponent
`protected void`	`doSaveToPageHistory()`	Saves the page of to the page history regardless of the status or isTrack()
`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()`	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
`java.lang.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.
`java.lang.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.
`java.lang.String`	`getLastMsgID()`
`protected java.lang.String`	`getPageHistoryKey()`
`protected PageHistoryList`	`getPageHistoryList()`
`PageInfo`	`getPageInfo()`
`java.lang.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.
`java.lang.String`	`getTemplateFileName()`	Returns the name of a template file to redirect
`TemplateInfo`	`getTemplateInfo()`	Convenience method.
`java.lang.String`	`getTitle()`	Returns the pages's title.
`java.lang.String`	`getTitleDescriptorId()`
`WebIServerSession`	`getWebIServerSession()`
`java.lang.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.
`boolean`	`isUntrack()`	Whether current page should not be tracked.
`protected WebEventHandler`	`newDefaultEventHandler()`
`void`	`persistBeans()`	For each one of the beans defined, saves their State through the StateManager for future use in this page.
`void`	`processApplyChanges(java.lang.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.
`protected void`	`saveToPageHistory()`	Saves the information of the last visited page so it can be restored by open history list page 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)
`protected void`	`setObjectBeanPageTitle(ObjectBean bean)`
`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(java.lang.String value)`	Sets the name of a template file to redirect
`void`	`setTitle(java.lang.String title)`	Define the alias that the page will display when called.
`void`	`setUntrack(boolean untrack)`	Set whether current page should not be tracked.
`void`	`setWebIServerSession(WebIServerSession session)`	Deprecated. The method does not have any effect in the object
`void`	`switchPage(java.lang.String pageName, ServletWebComponent servletWebComponent)`	Replaces the current page in the Servlet with the indicated page

Methods inherited from class com.microstrategy.web.app.beans.CSRFConfirmationPageComponentImpl
getPageSource, setDescID

Methods inherited from class com.microstrategy.web.app.beans.AbstractPersistableAppComponent
addChildStateInfo, isCookieOpen, isSaveStateEnabled, saveState, saveState, saveState, saveState

Methods inherited from class com.microstrategy.web.app.beans.AbstractAppComponent
addChildStateInfo, compareChildsTargetWithCurrent, createTransformInstance, doCollectData, doCollectMinimalData, getAppContext, getContactInfo, getContainerServices, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getObjectSource, getResultFilterMode, getSession, getTargetBean, getTop, getType, getWebObjectsFactory, getWebObjectsFactory, getXMLStatus, hasChanged, hasTargetBeanChanged, haveChildrenChanged, initComponent, internalCollectData, isDialog, isForcedChildrenStateSaving, isIFrameRequest, isModal, isModalOpen, newDefaultBeanContext, newHiddenInputBuilder, newNamespaceEncoder, newStyleRequestContext, newURIBuilder, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setOutputFormat, setTop

Methods inherited from class com.microstrategy.web.beans.AbstractWebComponent
addChild, addChildStateInfo, addChildStateInfo, addChildStateInfo, addStateInfo, childValues, clearChildren, clearStateCache, getCachedState, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, handleRequest, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isChangeComparisonFlagSet, isFeatureAvailable, prepareForReuse, removeChild, removeChild, restoreState, restoreStateFromRequest, restoreStateFromRequest, saveXMLState, saveXMLState, saveXMLState, searchChild, setBeanContext, setBeanContext, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setParent, setPersistMode, setRenderingFilter, setStateCache, setTargetBean, setTargetBeanPath, setWebEventHandler

Methods inherited from class com.microstrategy.web.beans.AbstractTransformable
addTransform, addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, createTransformInstance, getBeanContext, getDefaultTransform, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, hasTransform, hasTransform, internalCollectData, internalCollectData, invalidateTransformCache, isTransformSuitable, transform, transform, transform, transform

Methods inherited from class com.microstrategy.utils.serialization.AbstractPersistable
doFlatState, getStateHandler, isXMLStateZipped, restoreState, restoreXMLState, saveXMLState

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microstrategy.web.app.beans.AppComponent
getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getResultFilterMode, getTop, isDialog, isForcedChildrenStateSaving, isModal, isModalOpen, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setTop

Methods inherited from interface com.microstrategy.web.app.beans.PageComponent
getContactInfo

Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState

Methods inherited from interface com.microstrategy.web.beans.RequestPersistable
restoreStateFromRequest, restoreStateFromRequest

Methods inherited from interface com.microstrategy.web.beans.Transformable
addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform

Methods inherited from interface com.microstrategy.web.beans.WebComponent
addChild, addChildStateInfo, addChildStateInfo, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler

- Field Detail
  - _page
```
protected PageInfo _page
```
  - _title
```
protected java.lang.String _title
```
  - _titleId
```
protected java.lang.String _titleId
```
- Constructor Detail
  - SharingConfirmationPageComponentImpl
```
public SharingConfirmationPageComponentImpl()
```
- Method Detail
  - setPageInfo
```
public void setPageInfo(PageInfo page)
```
    This method sets the current Page (the object with the current Page structure)
    
    Specified by:
    
    setPageInfo in interface PageComponent
    
    Parameters:
    
    page - Page object
  - getPageInfo
```
public PageInfo getPageInfo()
```
    Specified by:
    
    getPageInfo in interface PageComponent
    
    Returns:
    
    the current Page (that holds the Page structure)
  - getTemplateInfo
```
public TemplateInfo getTemplateInfo()
```
    Convenience method. Equivalent to calling: getPageInfo.getTemplateInfoList().getTemplateInfo(getXMLStatus())
    
    Specified by:
    
    getTemplateInfo in interface PageComponent
    
    Returns:
    
    the current templateinfo to be used by this page
  - getWebIServerSession
```
public WebIServerSession getWebIServerSession()
```
    Specified by:
    
    getWebIServerSession in interface PageComponent
    
    Returns:
    
    The WebIServerSession used by this page. If this page is not using a session, it returns null;
  - setWebIServerSession
```
@Deprecated
public void setWebIServerSession(WebIServerSession session)
```
    Deprecated.
    The method does not have any effect in the object
    
    Specified by:
    
    setWebIServerSession in interface PageComponent
    
    Parameters:
    
    session - The WebIServerSession to be used by this page.
  - persistBeans
```
public void persistBeans()
```
    For each one of the beans defined, saves their State through the StateManager for future use in this page.
  - generateOutput
```
public MarkupOutput generateOutput()
```
    Description copied from class: AbstractAppComponent
    
    Generates the output of a bean. It transforms the bean
    
    Specified by:
    
    generateOutput in interface WebComponent
    
    Overrides:
    
    generateOutput in class AbstractAppComponent
    
    Returns:
    
    Null for this component.
  - getContextMenuManager
```
@Deprecated
public ContextMenuManager getContextMenuManager()
```
    Deprecated.
    This method is not used by the application and will be removed in future versions.
    
    Specified by:
    
    getContextMenuManager in interface PageComponent
    
    Returns:
    
    The Page's ContextMenuManager
  - setErrorInfo
```
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.
    
    Specified by:
    
    setErrorInfo in interface PageComponent
    
    Parameters:
    
    error - The last error on this page. null if none happened
  - setTitle
```
public void setTitle(java.lang.String title)
```
    Define the alias that the page will display when called.
    
    Specified by:
    
    setTitle in interface PageComponent
    
    Parameters:
    
    title - String with the title of the page. User setTitle
  - getTitle
```
public java.lang.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 PageComponent.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.
    The expected bean types are:
    
    ReportFrameBean: the objectName of the associated ReportBean is used. The title will depend as well in the status of the bean (i.e., if it's processing the name is prefixed with Executing ()
    DocumentFrameBean: the objectName of the associated DocumentBean is used. The title will depend as well in the status of the bean
    ObjectBean: it's object name
    PreferencesBean: the name of the current group set.
    Specified by:
    
    getTitle in interface PageComponent
    
    Returns:
    
    The title of this page
  - getTitleDescriptorId
```
public java.lang.String getTitleDescriptorId()
```
    Since:
    
    MicroStrategy Web 8.0.0
  - setObjectBeanPageTitle
```
protected void setObjectBeanPageTitle(ObjectBean bean)
```
  - executePreCollectDataAddons
```
public void executePreCollectDataAddons()
```
    Executes the addons on the page in the order in which they appear in the pageconfig file.
    
    Specified by:
    
    executePreCollectDataAddons in interface PageComponent
    
    Since:
    
    MicroStrategy Web 7.5.0
  - getErrorInfo
```
public AppBeanError getErrorInfo()
```
    Returns the last AppBeanError set to this page. If no errors have been associated to this page it returns null.
    
    Specified by:
    
    getErrorInfo in interface PageComponent
    
    Returns:
    
    the AppBeanError associated with the execution of the page.
  - hasBinaryContent
```
public boolean hasBinaryContent()
```
    Specified by:
    
    hasBinaryContent in interface PageComponent
    
    Returns:
    
    true if the page would generate binary content in it's output
  - getFontSize
```
public java.lang.String getFontSize()
```
    A string with the base font size to use, the string might contain the type of size (i.e, pt, px, etc.)
    
    Specified by:
    
    getFontSize in interface PageComponent
    
    Returns:
    
    a string with size of the font to use
  - getFontName
```
public java.lang.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
    
    Specified by:
    
    getFontName in interface PageComponent
    
    Returns:
    
    a String with a comma separated list of the fonts to use in this page.
  - setTemplateFileName
```
public void setTemplateFileName(java.lang.String value)
```
    Sets the name of a template file to redirect
    
    Specified by:
    
    setTemplateFileName in interface PageComponent
    
    Parameters:
    
    value - String value indicating the template file name to use.
  - getTemplateFileName
```
public java.lang.String getTemplateFileName()
```
    Returns the name of a template file to redirect
    
    Specified by:
    
    getTemplateFileName in interface PageComponent
    
    Returns:
    
    a file name.
  - executeCollectDataRequiredAddons
```
public boolean executeCollectDataRequiredAddons(WebComponent wc)
```
    Checks if the different addons associated with the WebComponent require a collect data to be performed.
    
    Specified by:
    
    executeCollectDataRequiredAddons in interface PageComponent
    
    Parameters:
    
    wc - WebComponent instance that will have its addon methods called
    
    Returns:
    
    boolean value indicating if the collectData is required or not
    
    Since:
    
    MicroStrategy Web 8.0.0
  - executePostCollectDataAddons
```
public void executePostCollectDataAddons()
```
    Description copied from interface: PageComponent
    
    Executes the post collect data addons on the page in the order in which they appear in the pageconfig file.
    
    Specified by:
    
    executePostCollectDataAddons in interface PageComponent
    
    Since:
    
    MicroStrategy Web 7.5.0
  - collectData
```
public void collectData()
                 throws WebBeanException
```
    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.
    
    Specified by:
    
    collectData in interface WebComponent
    
    Overrides:
    
    collectData in class AbstractAppComponent
    
    Throws:
    
    WebBeanException - thrown if there is any exception
    
    Since:
    
    MicroStrategy Web 8.0.0
  - collectMinimalData
```
public void collectMinimalData()
                        throws WebBeanException
```
    Description copied from class: AbstractAppComponent
    
    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 AbstractAppComponent.isOpen(), this method will first perform a AbstractAppComponent.doCollectMinimalData(), then proceeds to call AbstractAppComponent.collectMinimalData() on all child components AbstractWebComponent.getChild(int).
    
    Specified by:
    
    collectMinimalData in interface WebComponent
    
    Overrides:
    
    collectMinimalData in class AbstractAppComponent
    
    Throws:
    
    WebBeanException - thrown if an error occurs during this operation.
  - saveReturnToPage
```
public void saveReturnToPage(int mode)
```
    Saves the information of the last visited page so it can be restored by the returnTo event.
    
    Specified by:
    
    saveReturnToPage in interface PageComponent
    
    Parameters:
    
    mode - int value indicating the type of action that should be performed about the return to page information. Values includePageComponent.STORE_PAGE and PageComponent.REMOVE_PAGE.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - saveToPageHistory
```
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
  - doSaveToPageHistory
```
protected void doSaveToPageHistory()
```
    Saves the page of to the page history regardless of the status or isTrack()
  - getPageHistoryKey
```
protected java.lang.String getPageHistoryKey()
```
    Returns:
    
    a key unique to the page used for the page history.
  - getPageHistoryList
```
protected PageHistoryList getPageHistoryList()
```
    Returns:
    
    the page history list object
  - processApplyChanges
```
public void processApplyChanges(java.lang.String pageName)
                         throws WebException
```
    The method will be responsible for executing the apply events to those beans that require to so, when the page is about to change
    
    Specified by:
    
    processApplyChanges in interface PageComponent
    
    Parameters:
    
    pageName - The name of the new page
    
    Throws:
    
    WebException
    
    Since:
    
    MicroStrategy Web 8.0.0
  - setChanged
```
public void setChanged(boolean value)
```
    Description copied from class: AbstractWebComponent
    
    Sets the changed state of the component
    
    Specified by:
    
    setChanged in interface WebComponent
    
    Overrides:
    
    setChanged in class AbstractWebComponent
    
    Parameters:
    
    value - a boolean value indicating whether the component is changed.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - saveLastPage
```
public void saveLastPage()
```
    Description copied from interface: PageComponent
    
    Saves the information of the last succesful page so it can be restored by the cancel event.
    
    Specified by:
    
    saveLastPage in interface PageComponent
  - isOpen
```
public boolean isOpen()
```
    Description copied from class: AbstractAppComponent
    
    Returns a boolean value indicating if the instance is marked as opened or closed.
    
    Specified by:
    
    isOpen in interface AppComponent
    
    Overrides:
    
    isOpen in class AbstractAppComponent
    
    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.
    
    Since:
    
    MicroStrategy Web 8.0.1
    
    See Also:
    
    AppComponent.isOpen()
  - doFlatState
```
protected void doFlatState(FlatStateSerializer serializer,
                           int howMuchState,
                           FlatStateTokenizer tokenizer)
```
    Description copied from class: AbstractPersistableAppComponent
    
    Proceses the save/restore state opperation of the AppComponent
    
    Overrides:
    
    doFlatState in class AbstractPersistableAppComponent
    
    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
    
    Since:
    
    MicroStrategy Web 8.1.0
  - setScreenMode
```
public void setScreenMode(int screenMode)
```
    Description copied from interface: PageComponent
    
    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).
    
    Specified by:
    
    setScreenMode in interface PageComponent
    
    Since:
    
    MicroStrategy Web 8.1.0
  - getScreenMode
```
public int getScreenMode()
```
    Description copied from interface: PageComponent
    
    Return the current page screen mode.
    
    Specified by:
    
    getScreenMode in interface PageComponent
    
    Returns:
    
    page screen mode.
    
    Since:
    
    MicroStrategy Web 8.1.0
  - setExplicitScreenMode
```
public void setExplicitScreenMode(int screenMode)
```
    Description copied from interface: PageComponent
    
    Use to set the explicit screen mode.
    
    Specified by:
    
    setExplicitScreenMode in interface PageComponent
    
    Since:
    
    MicroStrategy Web 8.1.0
  - getExplicitScreenMode
```
public int getExplicitScreenMode()
```
    Specified by:
    
    getExplicitScreenMode in interface PageComponent
    
    Returns:
    
    integer value representing the explicit screen mode selected
    
    Since:
    
    MicroStrategy Web 8.1.0
  - getFeaturesManager
```
public WebFeatures getFeaturesManager()
```
    Description copied from class: AbstractAppComponent
    
    Return the WebFeatures implementation associated with this WebComponent
    
    Specified by:
    
    getFeaturesManager in interface WebComponent
    
    Overrides:
    
    getFeaturesManager in class AbstractAppComponent
    
    Returns:
    
    a WebFeatures instance
    
    Since:
    
    MicroStrategy Web 8.1.0
  - newDefaultEventHandler
```
protected WebEventHandler newDefaultEventHandler()
```
    Overrides:
    
    newDefaultEventHandler in class AbstractWebComponent
  - cleanUp
```
public void cleanUp()
```
    Description copied from interface: PageComponent
    
    Performs any necessary clean up tasks before leaving the page.
    Called when event EnumServletEvents.WebEventOpenHistoryPage is submited
    
    Specified by:
    
    cleanUp in interface PageComponent
  - getResourceManager
```
public PageResourceManager getResourceManager()
```
    Description copied from interface: PageComponent
    
    Returns the instance of the PageResourceManager associated with the page. Returns null if the resource manager is disabled.
    
    Specified by:
    
    getResourceManager in interface PageComponent
    
    Returns:
    
    instance of PageResourceManager
  - getResourceManagerMode
```
public int getResourceManagerMode()
```
    Description copied from interface: PageComponent
    
    Returns the mode of the page manager set up on the page component. The values are defined in the PageResourceManager class
    
    Specified by:
    
    getResourceManagerMode in interface PageComponent
    
    Returns:
    
    positive integer when it is enabled.
  - isRedirect
```
public boolean isRedirect()
```
    Description copied from interface: PageComponent
    
    Indicates if the page will be sent down as a redirect response (HTTP 302) instead of an ok response (HTTP 200)
    
    Specified by:
    
    isRedirect in interface PageComponent
    
    Returns:
    
    boolean value indicating if the the page will be displayed as a redirect (HTTP 302) response
  - setIsRedirect
```
public void setIsRedirect(boolean redirect)
```
    Description copied from interface: PageComponent
    
    Sets the page as a redirect response (HTTP 302) instead of an ok response (HTTP 200)
    
    Specified by:
    
    setIsRedirect in interface PageComponent
    
    Parameters:
    
    redirect - boolean value indicating if the the page will be displayed as a redirect (HTTP 302) response
  - getRedirectURL
```
public java.lang.String getRedirectURL()
```
    Description copied from interface: PageComponent
    
    Returns the URL to be send down to the browser that corresponds to the page.
    
    Specified by:
    
    getRedirectURL in interface PageComponent
    
    Returns:
    
    a URL String
  - getXMLStatusPageName
```
public java.lang.String getXMLStatusPageName()
```
    Description copied from interface: PageComponent
    
    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
    
    Specified by:
    
    getXMLStatusPageName in interface PageComponent
    
    Returns:
    
    String. Page Name from pageConfig.xml
  - switchPage
```
public void switchPage(java.lang.String pageName,
                       ServletWebComponent servletWebComponent)
                throws WebBeanException,
                       WebException
```
    Description copied from interface: PageComponent
    
    Replaces the current page in the Servlet with the indicated page
    
    Specified by:
    
    switchPage in interface PageComponent
    
    Parameters:
    
    pageName - . Name of the new page to instantiate
    
    Throws:
    
    WebBeanException
    
    WebException - When it fails to redirects to the target page.
  - hasXMLStatusPage
```
public boolean hasXMLStatusPage()
```
    Description copied from interface: PageComponent
    
    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
    
    Specified by:
    
    hasXMLStatusPage in interface PageComponent
    
    Returns:
    
    true is a page Name has been defined in pageConfig.xml
  - isStagePage
```
public boolean isStagePage()
```
    Description copied from interface: PageComponent
    
    Returns true if this page is just a stage page which acts as a bridge between two pages.
    
    Specified by:
    
    isStagePage in interface PageComponent
    
    Returns:
    
    true is this page is a stage page.
  - setStagePage
```
public void setStagePage(boolean isStagePage)
```
    Description copied from interface: PageComponent
    
    Sets the page as a stage page which acts as a bridge between two pages.
    
    Specified by:
    
    setStagePage in interface PageComponent
    
    Parameters:
    
    isStagePage - boolean value indicating if the the page is a stagePage.
  - getDebugOut
```
public MarkupOutput getDebugOut(int debugFlags)
```
    Description copied from interface: PageComponent
    
    Get the Debug Information into the output
    
    Specified by:
    
    getDebugOut in interface PageComponent
    
    Returns:
    
    an instance of MarkupOutput.
  - getDebugFlags
```
public int getDebugFlags()
```
    Description copied from interface: PageComponent
    
    Get the decimal-format debug flags from the page
    
    Specified by:
    
    getDebugFlags in interface PageComponent
  - isRestoredFromPageHistory
```
public boolean isRestoredFromPageHistory()
```
    Specified by:
    
    isRestoredFromPageHistory in interface PageComponent
  - setRestoredFromPageHistory
```
public void setRestoredFromPageHistory(boolean value)
```
    Specified by:
    
    setRestoredFromPageHistory in interface PageComponent
  - getLastMessageKey
```
public int getLastMessageKey()
```
    Read message key for active session.
    
    Specified by:
    
    getLastMessageKey in interface PageComponent
    
    Returns:
    
    {int}
  - getLastMsgID
```
public java.lang.String getLastMsgID()
```
    Specified by:
    
    getLastMsgID in interface PageComponent
  - setUntrack
```
public void setUntrack(boolean untrack)
```
    Description copied from interface: PageComponent
    
    Set whether current page should not be tracked.
    
    Specified by:
    
    setUntrack in interface PageComponent
    
    Parameters:
    
    untrack - Whether current page should not be tracked.
  - isUntrack
```
public boolean isUntrack()
```
    Description copied from interface: PageComponent
    
    Whether current page should not be tracked. The difference between this API and PageInfo.isTrack() is, this API's value comes from URL while PageInfo.isTrack() comes from pageConfig.xml
    
    Specified by:
    
    isUntrack in interface PageComponent
    
    Returns:
    
    Whether current page should not be untracked.

Modifier and Type	Field	Description
`protected PageInfo`	`_page`
`protected java.lang.String`	`_title`
`protected java.lang.String`	`_titleId`

Class SharingConfirmationPageComponentImpl

Field Summary

Fields inherited from class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

Fields inherited from class com.microstrategy.web.beans.AbstractWebComponent

Fields inherited from class com.microstrategy.web.beans.AbstractTransformable

Fields inherited from class com.microstrategy.utils.serialization.AbstractPersistable

Fields inherited from interface com.microstrategy.web.app.beans.AppComponent

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

Fields inherited from interface com.microstrategy.web.app.beans.PageComponent

Constructor Summary

Method Summary

Methods inherited from class com.microstrategy.web.app.beans.CSRFConfirmationPageComponentImpl

Methods inherited from class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

Methods inherited from class com.microstrategy.web.app.beans.AbstractAppComponent

Methods inherited from class com.microstrategy.web.beans.AbstractWebComponent

Methods inherited from class com.microstrategy.web.beans.AbstractTransformable

Methods inherited from class com.microstrategy.utils.serialization.AbstractPersistable

Methods inherited from class java.lang.Object

Methods inherited from interface com.microstrategy.web.app.beans.AppComponent

Methods inherited from interface com.microstrategy.web.app.beans.PageComponent

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

Methods inherited from interface com.microstrategy.web.beans.RequestPersistable

Methods inherited from interface com.microstrategy.web.beans.Transformable

Methods inherited from interface com.microstrategy.web.beans.WebComponent

Field Detail

_page

_title

_titleId

Constructor Detail

SharingConfirmationPageComponentImpl

Method Detail

setPageInfo

getPageInfo

getTemplateInfo

getWebIServerSession

setWebIServerSession

persistBeans

generateOutput

getContextMenuManager

setErrorInfo

setTitle

getTitle

getTitleDescriptorId

setObjectBeanPageTitle

executePreCollectDataAddons

getErrorInfo

hasBinaryContent

getFontSize

getFontName

setTemplateFileName

getTemplateFileName

executeCollectDataRequiredAddons

executePostCollectDataAddons

collectData

collectMinimalData

saveReturnToPage

saveToPageHistory

doSaveToPageHistory

getPageHistoryKey

getPageHistoryList

processApplyChanges

setChanged

saveLastPage

isOpen

doFlatState

setScreenMode

getScreenMode

setExplicitScreenMode

getExplicitScreenMode

getFeaturesManager

newDefaultEventHandler

cleanUp

getResourceManager

getResourceManagerMode

isRedirect

setIsRedirect

getRedirectURL

getXMLStatusPageName

switchPage

hasXMLStatusPage