Package com.microstrategy.web.app.beans
Interface FrameBean
-
- All Superinterfaces:
AppComponent
,EnumWebPersistableState
,Persistable
,RequestPersistable
,Transformable
,WebComponent
- All Known Subinterfaces:
DocumentFrameBean
,FilterFrameBean
,ReportFrameBean
,RWFrameBean
- All Known Implementing Classes:
ReportFrameBeanImpl
public interface FrameBean extends AppComponent, RequestPersistable
The interface FrameBean is representing the frame web component, that might contain any data bean and its editors, such as a Report or a Document bean.
A frame usually consists of a Menu, the data and an editor, the FrameBean provides methods to access these elements.
A FrameBean is generally used within a page that supports iFrame updates. In this case when the page needs to be refreshed, only the components that changed are sent to the iFrame which then updates the main page, this improves both performance and usability. The FrameBean provides methods for this functionality.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
-
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
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
closeElement(FrameElement element)
Mark as closed the corresponding FrameElementFrameElement
getCurrentEditor()
It returns which is the current editor to be displayied.java.lang.String
getDynamicMenuName()
Name of the Shortcut object to use as Dynamic Menujava.lang.String
getEditorMessage()
This method is used to set a message related with an Editor action.java.lang.Object
getIFrameComponent(java.lang.String name)
Returns the associated object associated with the iFrame component.Menu
getMenus()
Returns the menus for this FrameBean based on the dynamicMenuName property.java.lang.String
getMessageBeforeData()
Deprecated.java.lang.String
getPromptStyle()
Indicates actual prompt style used.WebComponent
getTargetBean()
Returns the target bean associated with this FrameBean.boolean
getUseIFrame()
Returns if the ReportFrame uses IFramesboolean
isOpen(FrameElement element)
Checks if the given FrameElement is openvoid
openElement(FrameElement element)
Mark as opened the corresponding FrameElementvoid
setDynamicMenuName(java.lang.String dynamicMenuName)
Name of the Shortcut object to use as DynamicMenuvoid
setEditorMessage(java.lang.String message)
This method is used to set a message related with an Editor action.void
setMessageBeforeData(java.lang.String message)
Deprecated.void
setPromptStyle(java.lang.String style)
Specifies which style to use for prompt transforms.void
setUseIFrame(boolean value)
Defines if the ReportFrame should use IFrameboolean
shouldDisplayContent(java.lang.String name)
Returns false if an iFrame component needs not to be rendered in an iFrame request.-
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.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
-
-
-
-
Method Detail
-
setUseIFrame
void setUseIFrame(boolean value)
Defines if the ReportFrame should use IFrame- Parameters:
value
- if true, the ReportFrame will use IFrames
-
getUseIFrame
boolean getUseIFrame()
Returns if the ReportFrame uses IFrames- Returns:
- true if frames are used.
-
getIFrameComponent
java.lang.Object getIFrameComponent(java.lang.String name)
Returns the associated object associated with the iFrame component. An iFrame component is any part of the interface that can be refreshed independently when using iFrames, for example a Bean, the current editor, the menus or the editor's message.- Parameters:
name
- the component's unique key- Returns:
- the object associated with the key. Null if no component is defined for that key.
- Since:
- MicroStrategy Web 8.0.0
-
shouldDisplayContent
boolean shouldDisplayContent(java.lang.String name)
Returns false if an iFrame component needs not to be rendered in an iFrame request.- Parameters:
name
- the component to render- Returns:
- false if the component should not be rendered, true otherwise.
-
openElement
void openElement(FrameElement element)
Mark as opened the corresponding FrameElement- Parameters:
element
- the element to open
-
closeElement
void closeElement(FrameElement element)
Mark as closed the corresponding FrameElement- Parameters:
element
- the element to close
-
isOpen
boolean isOpen(FrameElement element)
Checks if the given FrameElement is open- Parameters:
element
- Element to check- Returns:
- true if the element is open.
-
getTargetBean
WebComponent getTargetBean()
Returns the target bean associated with this FrameBean. The target bean is the one with the main data.- Specified by:
getTargetBean
in interfaceWebComponent
- Returns:
- the target bean for this Frame.
- Since:
- MicroStrategy Web 8.0.0
-
getCurrentEditor
FrameElement getCurrentEditor()
It returns which is the current editor to be displayied. Formatting editors (Grid or Graph), if current, are not considered.- Returns:
- the current editor,
-
setEditorMessage
void setEditorMessage(java.lang.String message)
This method is used to set a message related with an Editor action. The Editor after performing it's operation might set this message to inform the user about the success/failure of the action.- Parameters:
message
- the message to be shown.- Since:
- MicroStrategy Web 8.0.0
-
getEditorMessage
java.lang.String getEditorMessage()
This method is used to set a message related with an Editor action. The Editor after performing it's operation might set this message to inform the user about the success/failure of the action.- Returns:
- the message to be shown.
- Since:
- MicroStrategy Web 8.0.0
-
getMenus
Menu getMenus()
Returns the menus for this FrameBean based on the dynamicMenuName property.- Returns:
- a Menu object for this FrameBean.
- Since:
- MicroStrategy Web 8.0.0
-
setDynamicMenuName
void setDynamicMenuName(java.lang.String dynamicMenuName)
Name of the Shortcut object to use as DynamicMenu- Parameters:
dynamicMenuName
- the name ot use- Since:
- MicroStrategy Web 8.0.0
-
getDynamicMenuName
java.lang.String getDynamicMenuName()
Name of the Shortcut object to use as Dynamic Menu- Returns:
- the DynamicMenu name
- Since:
- MicroStrategy Web 8.0.0
-
setMessageBeforeData
void setMessageBeforeData(java.lang.String message)
Deprecated.
-
getMessageBeforeData
java.lang.String getMessageBeforeData()
Deprecated.
-
setPromptStyle
void setPromptStyle(java.lang.String style)
Specifies which style to use for prompt transforms.
This property indicates what prompt style to use when transforming a prompted Bean.- Parameters:
style
- String- Since:
- MicroStrategy Web 7.5.1
-
getPromptStyle
java.lang.String getPromptStyle()
Indicates actual prompt style used.- Returns:
- String name of prompt style.
- Since:
- MicroStrategy Web 7.5.1
-
-