Package com.microstrategy.web.app.beans
Interface FrameElement
-
- All Superinterfaces:
AppComponent
,EnumWebPersistableState
,Persistable
,RequestPersistable
,Transformable
,WebComponent
- All Known Subinterfaces:
AlertsEditorBean
,AttributeFormsEditorBean
,AttributeFormsQualificationBean
,ColorGradientEditorBean
,ColorPickerEditorBean
,DerivedElementsEditorBean
,DocumentFrameElement
,DrillEditorBean
,DrillFilterEditorBean
,ExportOptionsEditorBean
,FilterEditorBean
,FilterElementBean
,FormulaBarBean
,GraphColorGradientEditorBean
,GraphFormatEditorBean
,GraphFormatToolbarBean
,GridColorGradientEditorBean
,GridFormatBean
,GridFormatEditorBean
,GridFormatToolbarBean
,ObjectBrowserBean
,PageByBean
,PageSetupHTMLEditorBean
,ProjectBrowser
,ReportFrameElement
,ResizeEditorBean
,RWActionControlEditorBean
,RWDColorGradientEditorBean
,SecondaryDataSourcesEditorBean
,SortEditorBean
,SubscriptionEditorBean
,SubsetUnitLimitElementBean
,SubtotalsEditorBean
,ThresholdEditorBean
,ViewFilterElementPanelBean
,VisualizationPropertiesEditorBean
,VisualizationsEditorBean
- All Known Implementing Classes:
AbstractColorGradientEditorBeanImpl
,AttributeFormsQualificationBeanImpl
,ColorGradientEditorBeanImpl
,DrillEditorBeanImpl
,GraphColorGradientEditorBeanImpl
,GridColorGradientEditorBeanImpl
,PageSetupHTMLEditorBeanImpl
,ProjectBrowserBeanImpl
,RWDColorGradientEditorBeanImpl
,SecondaryDataSourcesEditorBeanImpl
,ViewFilterElementPanelBeanImpl
,VisualizationPropertiesEditorBeanImpl
,VisualizationsEditorBeanImpl
public interface FrameElement extends AppComponent, RequestPersistable
The interface FrameElement is representing the subcomponents inside a FrameBean.- 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 Modifier and Type Method Description FrameBean
getFrameBean()
Returns the frame bean that is containing this FrameElement.WebComponent
getTargetBean()
Get the target bean associated with this instancejava.lang.String
getTargetBeanPath()
boolean
getUseIFrame()
Indicates whether a ReportFrameElement uses IFrames in its outputboolean
isEditor()
Indicates whether a ReportFrameElement most be considered editor.boolean
isEnabled()
Indicates whether a ReportFrameElement is Enabled.void
setTargetBean(WebComponent bean)
Set the target bean that will be associated with this instance.void
setTargetBeanPath(java.lang.String beanName)
Define the base bean for this instance.void
setUseIFrame(boolean value)
Sets whether a ReportFrameElement should use IFrames in its output-
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, 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, setWebEventHandler
-
-
-
-
Method Detail
-
getFrameBean
FrameBean getFrameBean()
Returns the frame bean that is containing this FrameElement.- Returns:
- the frame bean that is containing this FrameElement.
-
setUseIFrame
void setUseIFrame(boolean value)
Sets whether a ReportFrameElement should use IFrames in its output- Parameters:
value
- true if IFrrames are enabled
-
getUseIFrame
boolean getUseIFrame()
Indicates whether a ReportFrameElement uses IFrames in its output- Returns:
- true if it uses IFrames
-
isEditor
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:
- true if the bean is an editor
-
isEnabled
boolean isEnabled()
Indicates whether a ReportFrameElement is Enabled. Each bean checks its own features and other settings to determine whether it is enabled or not.- Returns:
- true if the bean is enabled and ready to be rendered.
-
setTargetBeanPath
void setTargetBeanPath(java.lang.String beanName)
Description copied from interface:WebComponent
Define the base bean for this instance.- Specified by:
setTargetBeanPath
in interfaceWebComponent
- Parameters:
beanName
-String
with the name of the bean (with path information if necessary) to be set as the base bean for this instance.- Since:
- MicroStrategy Web 8.0.0
-
getTargetBeanPath
java.lang.String getTargetBeanPath()
- Specified by:
getTargetBeanPath
in interfaceWebComponent
- Returns:
- a
String
value with the name of the bean defined to be associated with this instance, if any. - Since:
- MicroStrategy Web 8.0.0
-
setTargetBean
void setTargetBean(WebComponent bean)
Description copied from interface:WebComponent
Set the target bean that will be associated with this instance.- Specified by:
setTargetBean
in interfaceWebComponent
- Parameters:
bean
-WebComponent
instance to be associated with this bean.- Since:
- MicroStrategy Web 8.0.0
-
getTargetBean
WebComponent getTargetBean()
Description copied from interface:WebComponent
Get the target bean associated with this instance- Specified by:
getTargetBean
in interfaceWebComponent
- Returns:
WebComponent
instance associated with this bean.- Since:
- MicroStrategy Web 8.0.0
-
-