Package com.microstrategy.web.app.beans
Class AbstractPersistableFrameElement
- 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.AbstractPersistableFrameElement
-
- All Implemented Interfaces:
EnumWebPersistableState
,Persistable
,AppComponent
,RequestPersistable
,Transformable
,WebComponent
- Direct Known Subclasses:
AbstractFrameEditorBean
,AbstractObjectExplorerBean
,AbstractViewBeanParserBean
,ControlToolbarBeanImpl
,PageSetupHTMLEditorBeanImpl
public abstract class AbstractPersistableFrameElement extends AbstractPersistableAppComponent
This class is the abstract realization of the FrameElement. Implements most of the methods except the isEnabled(), which needs to be implemented by every concrete class.
Notice that in general the FrameElement doesn't implement Persistable, although this class does since most of the FrameElements requires it. Also notice that this class DOES NOT implement the FrameElement interface. This is on purpose. The reason being this class is extended by concrete classes that doesn't necessary extend the FrameElement (in particular, this class is extended by the AbstractEditorBean). The FrameElement will be deprecated in favor of the EditorBean interface. In this scenario all classes will inherit the methods (even if they don't use it), true, but if their interface doesn't extend the FrameElement, the methods will not be publicly available so no harm is done.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
-
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
-
-
Constructor Summary
Constructors Constructor Description AbstractPersistableFrameElement()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
doCollectData()
Extends collectData by setting the Persistable mode to Default (do not persist) if the bean is a FrameElement and it's not editable.DocumentFrameBean
getDocumentFrameBean()
Returns theDocumentFrameBean
associated with this report frame element.WebFeatures
getFeaturesManager()
Overrides getFeaturesManager by providing a new Features implementation for FrameElements.FrameBean
getFrameBean()
Utility method for returning theFrameBean
associated with this instanceReportFrameBean
getReportFrameBean()
Returns theReportFrameBean
associated with this report frame element.RWFrameBean
getRWFrameBean()
Returns theRWFrameBean
associated with this report frame element.boolean
getUseIFrame()
Indicates whether a ReportFrameElement uses IFrames in its outputboolean
isEditor()
Indicates whether a ReportFrameElement most be considered editor.boolean
isGridDataNecessary()
This method indicates the report frame that the element requires the grid for information.boolean
isIFrameEnabled()
boolean
isOpen()
Overrides isOpen by making sure FrameElements use the FrameBean to control their open-close status.void
setIsOpen(boolean value)
Overrides setIsOpen by making sure FrameElements use the FrameBean to control their open-close status.void
setUseIFrame(boolean value)
Sets whether a ReportFrameElement should use IFrames in its output-
Methods inherited from class com.microstrategy.web.app.beans.AbstractPersistableAppComponent
addChildStateInfo, doFlatState, isCookieOpen, isSaveStateEnabled, saveState, saveState, saveState, saveState
-
Methods inherited from class com.microstrategy.web.app.beans.AbstractAppComponent
addChildStateInfo, collectData, collectMinimalData, compareChildsTargetWithCurrent, createTransformInstance, doCollectMinimalData, generateOutput, 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, 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, newDefaultEventHandler, prepareForReuse, removeChild, removeChild, restoreState, restoreStateFromRequest, restoreStateFromRequest, saveXMLState, saveXMLState, saveXMLState, searchChild, setBeanContext, setBeanContext, setChanged, 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.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, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform
-
Methods inherited from interface com.microstrategy.web.beans.WebComponent
addChild, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, handleRequest, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler
-
-
-
-
Method Detail
-
getReportFrameBean
public ReportFrameBean getReportFrameBean()
Returns theReportFrameBean
associated with this report frame element.- Returns:
- the report frame bean associated with this report frame element.
-
getDocumentFrameBean
public DocumentFrameBean getDocumentFrameBean()
Returns theDocumentFrameBean
associated with this report frame element.- Returns:
- the document frame bean associated with this report frame element.
-
getRWFrameBean
public RWFrameBean getRWFrameBean()
Returns theRWFrameBean
associated with this report frame element.- Returns:
- the RW Frame bean associated with this report frame element.
- Since:
- MicroStrategy Web 8.0.0
-
getFrameBean
public FrameBean getFrameBean()
Utility method for returning theFrameBean
associated with this instance- Returns:
FrameBean
instance that could correspond to aReportFrameBean
,DocumentFrameBean
orRWFrameBean
.
-
isIFrameEnabled
public boolean isIFrameEnabled()
- Returns:
True
if IFrame is enabled for this instance.
-
setUseIFrame
public void setUseIFrame(boolean value)
Sets whether a ReportFrameElement should use IFrames in its output- Parameters:
value
- true if IFrrames are enabled
-
getUseIFrame
public boolean getUseIFrame()
Indicates whether a ReportFrameElement uses IFrames in its output- Returns:
- true if it uses IFrames
-
isEditor
public boolean isEditor()
Indicates whether a ReportFrameElement most be considered editor. Editors are treated specially by the ReportFrame: only one editor can be shown at any time.- Returns:
- false, editors needs to override this method.
-
isGridDataNecessary
public boolean isGridDataNecessary()
This method indicates the report frame that the element requires the grid for information. Editors that requires to grid data for their input should override this method, since by default it returns false. This method is implemented for the ReportFrameElement interface.- Returns:
- false.
-
getFeaturesManager
public WebFeatures getFeaturesManager()
Overrides getFeaturesManager by providing a new Features implementation for FrameElements.- Specified by:
getFeaturesManager
in interfaceWebComponent
- Overrides:
getFeaturesManager
in classAbstractAppComponent
- Returns:
- a FrameElementsFeatures if the concrete bean implements FrameElement, otherwise the default FeaturesManager.
- Since:
- MicroStrategy Web 8.0.0
-
setIsOpen
public void setIsOpen(boolean value)
Overrides setIsOpen by making sure FrameElements use the FrameBean to control their open-close status. If the bean is a FrameElement and has a FrameBean as a parent, then it will ask the FrameBean to open or close it accordingly, otherwise it would use the default setIsOpen implementation.- Specified by:
setIsOpen
in interfaceAppComponent
- Overrides:
setIsOpen
in classAbstractAppComponent
- Parameters:
value
-boolean
value indicating if the instance should be defined as opened (True
) or closed (False
).- Since:
- MicroStrategy Web 8.0.0
-
isOpen
public boolean isOpen()
Overrides isOpen by making sure FrameElements use the FrameBean to control their open-close status. If the bean is a FrameElement and has a FrameBean as a parent, then it will ask the FrameBean if it's open, otherwise it would use the default isOpen implementation.- Specified by:
isOpen
in interfaceAppComponent
- Overrides:
isOpen
in classAbstractAppComponent
- Returns:
- boolean true if open
- Since:
- MicroStrategy Web 8.0.0
-
doCollectData
public void doCollectData()
Extends collectData by setting the Persistable mode to Default (do not persist) if the bean is a FrameElement and it's not editable.- Overrides:
doCollectData
in classAbstractAppComponent
- Since:
- MicroStrategy Web 8.0.0
-
-