Package com.microstrategy.web.app.beans

Interface DocumentFrameBean

All Superinterfaces:

AppComponent, EnumWebPersistableState, FrameBean, Persistable, RequestPersistable, Transformable, WebComponent

public interface DocumentFrameBean
extends FrameBean

The interface DocumentFrameBean is representing the document frame web component, whose children components are of DocumentFrameElement type. Extends the FrameBean by adding all the document elements.

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	COMPONENT_DATA
static java.lang.String	COMPONENT_EDITOR
static java.lang.String	COMPONENT_EDITOR_MESSAGE
static java.lang.String	COMPONENT_MENUS
static java.lang.String	COMPONENT_PATH

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

Method Summary

Modifier and Type	Method	Description
DocumentBean	getDocumentBean()	Returns the report bean associated with this report frame bean.
PromptsContainerBean	getPromptsContainerBean()	Get the Prompts Container Bean.
SubscriptionEditorBean	getSchedulesEditorBean()	Returns the Subscription editor bean to use with web Subscriptions.
SubscriptionEditorBean	getSendNowEditorBean()	Returns the Subscription editor bean to use with Narrowcast Subscriptions.
SubscriptionEditorBean	getSubscriptionsEditorBean()	Returns the Subscription editor bean to use with Narrowcast Subscriptions.

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

getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getResultFilterMode, getTop, isDialog, isForcedChildrenStateSaving, isModal, isModalOpen, isOpen, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setTop

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

closeElement, getCurrentEditor, getDynamicMenuName, getEditorMessage, getIFrameComponent, getMenus, getMessageBeforeData, getPromptStyle, getTargetBean, getUseIFrame, isOpen, openElement, setDynamicMenuName, setEditorMessage, setMessageBeforeData, setPromptStyle, setUseIFrame, shouldDisplayContent

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

restoreState, restoreState, saveState, saveState, saveState, saveState

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, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler

Field Detail

COMPONENT_MENUS

static final java.lang.String COMPONENT_MENUS

Since:

MicroStrategy Web 8.0.0

See Also:

Constant Field Values

COMPONENT_DATA

static final java.lang.String COMPONENT_DATA

Since:

MicroStrategy Web 8.0.0

See Also:

Constant Field Values

COMPONENT_PATH

static final java.lang.String COMPONENT_PATH

Since:

MicroStrategy Web 8.0.0

See Also:

Constant Field Values

COMPONENT_EDITOR

static final java.lang.String COMPONENT_EDITOR

Since:

MicroStrategy Web 8.0.0

See Also:

Constant Field Values

COMPONENT_EDITOR_MESSAGE

static final java.lang.String COMPONENT_EDITOR_MESSAGE

Since:

MicroStrategy Web 8.0.0

See Also:

Constant Field Values

Method Detail

getDocumentBean

DocumentBean getDocumentBean()

Returns the report bean associated with this report frame bean.

Returns:

the report bean associated with this report frame bean

getSchedulesEditorBean

SubscriptionEditorBean getSchedulesEditorBean()

Returns the Subscription editor bean to use with web Subscriptions.

Returns:

the Subscription editor bean to use with web Subscriptions.

getSubscriptionsEditorBean

SubscriptionEditorBean getSubscriptionsEditorBean()

Returns the Subscription editor bean to use with Narrowcast Subscriptions.

Returns:

the Subscription editor bean to use with Narrowcast Subscriptions.

getSendNowEditorBean

SubscriptionEditorBean getSendNowEditorBean()

Returns the Subscription editor bean to use with Narrowcast Subscriptions.

Returns:

the Subscription editor bean to use with Narrowcast Subscriptions.

getPromptsContainerBean

PromptsContainerBean getPromptsContainerBean()

Get the Prompts Container Bean.

Returns:

the prompts container bean associated with the frame

Since:

MicroStrategy Web 9.0.0