com.microstrategy.web.app.beans.ReportFrameBean |
![]() |
The interface ReportFrameBean is representing the report frame web component, whose children components are of ReportFrameElement type. Extends the FrameBean by adding all the report elements.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | COMPONENT_DESIGN_MODE_BUTTONS | ||||||||||
String | COMPONENT_FORMAT_EDITOR | ||||||||||
String | COMPONENT_GRAPH_TOOLBAR | ||||||||||
String | COMPONENT_GRID_EDITOR | ||||||||||
String | COMPONENT_GRID_TOOLBAR | ||||||||||
String | COMPONENT_MESSAGE_BEFORE_DATA | ||||||||||
String | COMPONENT_OBJECT_BROWSER | ||||||||||
String | COMPONENT_PAGE_BY | ||||||||||
String | COMPONENT_PROMPT_DETAILS | ||||||||||
String | COMPONENT_REPORT_DATA | ||||||||||
String | COMPONENT_REPORT_ERROR | ||||||||||
String | COMPONENT_REPORT_FILTER | ||||||||||
String | COMPONENT_REPORT_LAST_UPDATE | ||||||||||
String | COMPONENT_REPORT_LIMIT | ||||||||||
String | COMPONENT_REPORT_MENUS | ||||||||||
String | COMPONENT_REPORT_PAGEBY | ||||||||||
String | COMPONENT_REPORT_TOOLBAR | ||||||||||
String | COMPONENT_VIEW_FILTER | ||||||||||
String | COMPONENT_VIEW_LIMIT | ||||||||||
String | COMPONENT_VISUALIZATION_PROPS_EDITOR |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
abstract AttributeFormsEditorBean |
getAttributeFormsEditorBean()
Returns the attribute forms editor bean within this report frame bean.
| ||||||||||
abstract DerivedElementsEditorBean | getDerivedElementsEditor() | ||||||||||
abstract int |
getDesignMode()
Returns the view mode of the report frame bean (a value from EnumReportViewModes)
| ||||||||||
abstract int |
getDesignModeStage()
Returns the design mode stage of the report frame bean
ReportDesignModeStage_EditTemplate or ReportDesignModeStage_EditFilter (EnumReportDesignMode))
| ||||||||||
abstract DrillEditorBean |
getDrillEditorBean()
Returns the drill editor bean within this report frame bean.
| ||||||||||
abstract DrillFilterEditorBean |
getDrillFilterEditorBean()
Returns the drill filter editor bean within this report frame bean.
| ||||||||||
abstract int |
getExecutionMode()
Returns the view mode of the report frame bean (a value from EnumReportViewModes)
including value for Create Report
| ||||||||||
abstract FilterElementBean | getFilterElement(int type) | ||||||||||
abstract FormulaBarBean |
getFormulaBarBean()
Returns the formular bar bean within this report frame bean.
| ||||||||||
abstract GraphFormatEditorBean |
getGraphFormatEditorBean()
Returns the graph format editor bean within this report frame bean.
| ||||||||||
abstract GraphFormatToolbarBean |
getGraphFormatToolbarBean()
Returns the graph format toolbar bean within this report frame bean.
| ||||||||||
abstract GridFormatEditorBean |
getGridFormatEditorBean()
Returns the grid format editor bean within this report frame bean.
| ||||||||||
abstract GridFormatToolbarBean |
getGridFormatToolbarBean()
Returns the grid format toolbar bean within this report frame bean.
| ||||||||||
abstract boolean |
getIsDesignMode()
Returns whether the view mode of the report frame bean (a value from EnumReportViewModes) is equal to
ReportViewModeDesign | ||||||||||
abstract ObjectBrowserBean |
getObjectBrowserBean()
This method is deprecated.
This method is no longer used. getObjectBrowserTabMgrBean() should be used instead
| ||||||||||
abstract ObjectBrowserManagerBean |
getObjectBrowserTabMgrBean()
Returns the ObjectBrowser bean associated with the report frame bean.
| ||||||||||
abstract PageByBean |
getPageByBean()
Returns the PageBy editor bean.
| ||||||||||
abstract PromptDetailsBean |
getPromptDetailsBean()
Returns a
PromptDetailsBean object corresponding to the prompt details. | ||||||||||
abstract PromptsContainerBean |
getPromptsContainerBean()
Returns a
PromptsContainerBean object corresponding to the prompts container. | ||||||||||
abstract boolean |
getRefreshGrid()
Retrieves the flag indicating whether to refresh the grid or not.
| ||||||||||
abstract ReportBean |
getReportBean()
Returns the report bean associated with this report frame bean.
| ||||||||||
abstract ReportDetailsBean |
getReportDetailsBean()
Returns a
ReportDetailsBean object corresponding to the report details. | ||||||||||
abstract String |
getReportEditorName()
Retrieves the name of the current open report editor
| ||||||||||
abstract FilterEditorBean |
getReportFilterEditor()
Returns the report filter editor bean within this report frame bean.
| ||||||||||
abstract FilterElementBean |
getReportFilterElement()
Returns a
FilterElementBean object corresponding to the report filter. | ||||||||||
abstract FilterElementBean | getReportLimitElement() | ||||||||||
abstract String |
getReportStyleLocalizedName()
This method is deprecated.
The FrameBean is not responsible to render it's output.
| ||||||||||
abstract ResizeEditorBean |
getResizeEditorBean()
Returns the resize editor bean within this report frame bean.
| ||||||||||
abstract SubscriptionEditorBean |
getSchedulesEditorBean()
This method is deprecated.
No longer used by the Application
| ||||||||||
abstract SubscriptionEditorBean |
getSendNowEditorBean()
This method is deprecated.
No longer used by the Application
| ||||||||||
abstract SortEditorBean |
getSortEditorBean()
Returns the sort editor bean within this report frame bean.
| ||||||||||
abstract SubscriptionEditorBean |
getSubscriptionsEditorBean()
This method is deprecated.
No longer used by the Application
| ||||||||||
abstract FilterEditorBean |
getViewFilterEditor()
Returns the view filter editor bean within this report frame bean.
| ||||||||||
abstract FilterElementBean |
getViewFilterElement()
Returns a
FilterElementBean object corresponding to the view filter. | ||||||||||
abstract FilterElementBean | getViewLimitElement() | ||||||||||
abstract boolean | isNoActionFlagRemoved() | ||||||||||
abstract boolean |
isReportToolbarEnabled()
Returns true if the report toolbar should be enabled
| ||||||||||
abstract void |
setDesignMode(int designMode)
Sets the view mode of the report frame bean (a value from EnumReportViewModes)
| ||||||||||
abstract void |
setDesignModeStage(int designModeStage)
Sets the design mode stage of the report frame bean
| ||||||||||
abstract void |
setExecutionMode(int executeMode)
Sets the view mode of the report frame bean (a value from EnumReportViewModes)
| ||||||||||
abstract void |
setNoActionFlagRemoved(boolean isRemoved)
Set this to true if we just removed the noAction flag from the executionFlags when switch a report from design mode to view mode
| ||||||||||
abstract void |
setRefreshGrid(boolean value)
Sets a flag indicating whether to refresh the grid or not.
| ||||||||||
abstract void |
setReportEditorName(String value)
Sets the name of the report editor to be open
| ||||||||||
abstract void |
setXMLStatus(int value)
Sets the EnumRequestStatus status of the bean.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
Returns the attribute forms editor bean within this report frame bean.
Returns the view mode of the report frame bean (a value from EnumReportViewModes)
Returns the design mode stage of the report frame bean ReportDesignModeStage_EditTemplate or ReportDesignModeStage_EditFilter (EnumReportDesignMode))
Returns the drill editor bean within this report frame bean.
Returns the drill filter editor bean within this report frame bean.
Returns the view mode of the report frame bean (a value from EnumReportViewModes) including value for Create Report
Returns the formular bar bean within this report frame bean.
Returns the graph format editor bean within this report frame bean.
Returns the graph format toolbar bean within this report frame bean.
Returns the grid format editor bean within this report frame bean.
Returns the grid format toolbar bean within this report frame bean.
Returns whether the view mode of the report frame bean (a value from EnumReportViewModes) is equal to ReportViewModeDesign
This method is deprecated.
This method is no longer used. getObjectBrowserTabMgrBean() should be used instead
Returns the ObjectBrowser bean associated with this report frame bean.
Returns the ObjectBrowser bean associated with the report frame bean. The ObjectBrowser is now a TabManagerBean.
Returns the PageBy editor bean.
Returns a PromptDetailsBean
object corresponding to the prompt details.
PromptDetailsBean
corresponding to the prompt details.Returns a PromptsContainerBean
object corresponding to the prompts container.
PromptsContainerBean
corresponding to the prompts Container.Retrieves the flag indicating whether to refresh the grid or not. This flag is only read when attribute forms editor is opened.
Returns the report bean associated with this report frame bean.
Returns a ReportDetailsBean
object corresponding to the report details.
ReportDetailsBean
corresponding to the report details.Retrieves the name of the current open report editor
Returns the report filter editor bean within this report frame bean.
Returns a FilterElementBean
object corresponding to the report filter.
FilterElementBean
corresponding to the report filter.
This method is deprecated.
The FrameBean is not responsible to render it's output.
Returns the resize editor bean within this report frame bean.
This method is deprecated.
No longer used by the Application
Returns the Subscription editor bean to use with web Subscriptions.
This method is deprecated.
No longer used by the Application
Returns the Subscription editor bean to use with Send Now feature.
Returns the sort editor bean within this report frame bean.
This method is deprecated.
No longer used by the Application
Returns the Subscription editor bean to use with Narrowcast Subscriptions.
Returns the view filter editor bean within this report frame bean.
Returns a FilterElementBean
object corresponding to the view filter.
FilterElementBean
corresponding to the view filter.Returns true if the report toolbar should be enabled
Sets the view mode of the report frame bean (a value from EnumReportViewModes)
designMode | the view mode of the report frame bean (a value from EnumReportViewModes) |
---|
Sets the design mode stage of the report frame bean
designModeStage | the design mode stage of the report frame bean (a value from EnumReportDesignMode) |
---|
Sets the view mode of the report frame bean (a value from EnumReportViewModes)
executeMode | the view mode of the report frame bean (a value from EnumReportViewModes) |
---|
Set this to true if we just removed the noAction flag from the executionFlags when switch a report from design mode to view mode
isRemoved | boolean true indicates we just remove the noAction flag from the executionFlags when switch a report from design mode to view mode |
---|
Sets a flag indicating whether to refresh the grid or not. This flag is only read when attribute forms editor is opened.
Sets the name of the report editor to be open
value | The name of the report editor to be open |
---|
Sets the EnumRequestStatus status of the bean.
value | The XML status value ofor this bean. |
---|