All Superinterfaces:

Transformable, WebComponent

All Known Subinterfaces:

AdminBean, AdminTabBean, AlertsEditorBean, AllObjectBrowserBean, AttributeFormsEditorBean, AttributeFormsQualificationBean, ChangePasswordBean, ColorGradientEditorBean, ColorPickerEditorBean, ConfirmOverwriteDialogBean, ContactsBrowserBean, ControlToolbarBean, DatasetObjectExplorerBean, DerivedElementFormatEditorBean, DerivedElementsBrowserBean, DerivedElementsConvertDialogBean, DerivedElementsEditorBean, DiagnosticsBean, DirectExportBean, DocumentFrameBean, DocumentFrameElement, DrillEditorBean, DrillFilterEditorBean, EditableObjectAppBean, ElementPickerBean, ExportBean, ExportOptionsEditorBean, FilterAppBean, FilterDetailsFormattingEditorBean, FilterEditorBean, FilterElementBean, FilterFrameBean, FlashTabBean, FolderFrameBean, FolderObjectExplorerBean, FormatColorLinesTabBean, FormatNumberTabBean, FormatTabBean, FormatTabManagerBean, FormatToolbarBean, FormulaBarBean, FrameBean, FrameElement, FunctionEditorBean, GraphColorGradientEditorBean, GraphFormatEditorBean, GraphFormatToolbarBean, GraphTitleTabBean, GridAutoStylesBean, GridColorGradientEditorBean, GridFormatBean, GridFormatEditorBean, GridFormatToolbarBean, GroupbyPropertiesEditorBean, GroupPathBean, ImportDerivedElementsBean, LoginBean, LogoutBean, MetricQualLevelEditorBean, ObjectBrowserBean, ObjectBrowserManagerBean, ObjectBrowserTabBean, ObjectExplorerBean, ObjectManipulationDialogBean, ObjectSelectionBean, OMDCreateFolderBean, OptionsBean, PageByBean, PageComponent, PageSetupHTMLEditorBean, PathBean, PDFBean, PreferencesBean, PrintBean, ProjectBrowser, ProjectsBean, ProjectStatusBean, PromptAppBean, PromptConstantAppBean, PromptDefinitionAppBean, PromptDetailsBean, PromptDimtyAppBean, PromptElementsAppBean, PromptExpressionAppBean, PromptHierarchyAppBean, PromptObjectAppBean, PromptsContainerBean, PromptsContainerFrameBean, ReportDetailsBean, ReportFrameBean, ReportFrameElement, ReportObjectsTabBean, ReportWorkingSetBrowserTabBean, ResizeEditorBean, ResultSetFrameBean, RibbonBean, RWActionControlEditorBean, RWDColorGradientEditorBean, RWFrameBean, RWGraphDropZonesEditorBean, RWProjectBrowserTabBean, RWWorkingSetBrowserTabBean, SaveAsBean, SaveObjectAsDialogBean, SearchBean, SecondaryDataSourcesEditorBean, SecurityFilterFrameBean, SecurityRoleUserEntitiesSelectorBean, SortEditorBean, SubscriptionContactsBrowserBean, SubscriptionEditorBean, SubscriptionFrameBean, SubsetUnitLimitElementBean, SubtotalsEditorBean, TabBean, TabManagerBean, TemplateElementsBean, TemplateFilterExecBean, ThresholdEditorBean, ToolbarBean, ToolbarSetBean, UserContactsBrowserBean, UserEntitiesBrowserBean, UserEntitiesSelectorBean, ViewBeanParserBean, ViewFilterElementPanelBean, VisualizationPropertiesEditorBean, VisualizationsEditorBean, WebHyperLinkEditorBean, WizardBean, WizardStepBean, XDADataExplorerBean

All Known Implementing Classes:

AbstractAppComponent, AbstractColorGradientEditorBeanImpl, AbstractFrameEditorBean, AbstractObjectBrowserTabBean, AbstractObjectExplorerBean, AbstractPersistableAppComponent, AbstractPersistableFrameElement, AbstractTemplateElementsBean, AbstractViewBeanParserBean, AccordionTabManagerBeanImpl, AllObjectBrowserBeanImpl, AttributeFormsQualificationBeanImpl, ColorGradientEditorBeanImpl, ControlToolbarBeanImpl, CreditsBean, CSRFConfirmationPageComponentImpl, DatasetObjectExplorerBeanImpl, DerivedElementsBrowserBeanImpl, DesktopPageComponentImpl, DocumentPageComponentImpl, DrillEditorBeanImpl, EditPromptPageComponentImpl, ElementPickerBeanImpl, FilterDetailsFormattingEditorBeanImpl, FolderObjectExplorerBeanImpl, FolderPageComponentImpl, GraphColorGradientEditorBeanImpl, GraphTitleTabBeanImpl, GridColorGradientEditorBeanImpl, HistoryListPageComponentImpl, IOSSmartBannerBeanImpl, MySubscriptionsPageComponentImpl, NewWindowPageComponentImpl, OptimizedTabBeanImpl, OptionsBeanImpl, PageSetupHTMLEditorBeanImpl, PageSubscriptionsEdit, PathBeanImpl, PreferencesBeanImpl, PreferenceSettingPageComponentImpl, PreferencesPageComponentImpl, ProjectBrowserBeanImpl, PromptDetailsBeanImpl, ReportDetailsBeanImpl, ReportFrameBeanImpl, ReportPageComponentImpl, ResultSetPageComponentImpl, RibbonBeanImpl, RWDColorGradientEditorBeanImpl, RWGraphDropZonesEditorBeanImpl, RWOIVMPageComponent, RWPageComponentImpl, RWPromptsPageComponent, RWSaveAsPageComponentImpl, SearchPageComponentImpl, SecondaryDataSourcesEditorBeanImpl, SecurityRoleUserEntitiesSelectorBeanImpl, ServletWebComponent, SharingConfirmationPageComponentImpl, SimplePageComponentImpl, ViewFilterElementPanelBeanImpl, VisualizationPropertiesEditorBeanImpl, VisualizationsEditorBeanImpl, XDADataExplorerBeanImpl
```
public interface AppComponent
extends WebComponent, Transformable
```
This interface is used to represent all application-level components. All of these components are strictly part of the Web Application framework. All application-level components are Web Components and thus this interface is derived from WebComponent.

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields
Modifier and Type Field Description

static int COMPONENT_POSITION_NOT_INITIALIZED
Constant indicating the value for the position of the bean has not been specified

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`AppContext`	`getAppContext()`	This method returns the application context object associated with this component.
`java.lang.String`	`getDescriptor(int key)`	Retrieve the descriptor when the key is an integer value...
`java.lang.String`	`getDescriptor(java.lang.String key)`	Retrieve the descriptor when the key is a string
`EventManager`	`getEventManager()`	This method returns the application EventManager used to generates events.
`java.lang.String`	`getExtraInput()`	Get any extra input form information to be used when generating form information on the transforms associated with this instance.
`java.lang.String`	`getExtraUrl()`	Get any extra url information to be used when generating link information on the transforms associated with this instance.
`int`	`getLeft()`	Get the left position where the bean should be displayed by the transform if applicable
`int`	`getResultFilterMode()`
`int`	`getTop()`	Get the top position where the bean should be displayed by the transform if applicable
`boolean`	`isDialog()`	Returns true if this bean should be treated as a dialog
`boolean`	`isForcedChildrenStateSaving()`	Return whether the state will be save despite it's open or closed state.
`boolean`	`isModal()`	Retrieves the modal state of the bean
`boolean`	`isModalOpen()`	indicates whether there is a Modal AppComponent open in the hierarchy
`boolean`	`isOpen()`	Retrieves the open/close state of the bean
`void`	`setExtraInput(java.lang.String newValue)`	Set any extra input form information to be used when generating form information on the transforms associated with this instance.
`void`	`setExtraUrl(java.lang.String newValue)`	Set any extra url information to be used when generating link information on the transforms associated with this instance.
`void`	`setForcedChildrenStateSaving(boolean value)`	Forces the bean state to be save despite it's open or closed state.
`void`	`setHasJustOpened(boolean value)`	Sets whether the component has just been opened.
`void`	`setIsDialog(boolean value)`	Sets the bean to its dialog mode.
`void`	`setIsModal(boolean value)`	Sets the bean to its modal mode.
`void`	`setIsOpen(boolean value)`	Sets the bean to its enabled mode, meaning the editor will be visible to the user
`void`	`setLeft(int x)`	Set the left position where the bean should be displayed by the transform if applicable.
`void`	`setTop(int y)`	Set the top position where the bean should be displayed by the transform if applicable.

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, getTargetBean, 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_POSITION_NOT_INITIALIZED
```
static final int COMPONENT_POSITION_NOT_INITIALIZED
```
    Constant indicating the value for the position of the bean has not been specified
    
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getAppContext
```
AppContext getAppContext()
```
    This method returns the application context object associated with this component. To set this context, use WebComponent.setBeanContext passing in an application context object.
    
    Returns:
    
    AppContext
  - getEventManager
```
EventManager getEventManager()
```
    This method returns the application EventManager used to generates events.
    
    Returns:
    
    EventManager
  - getDescriptor
```
java.lang.String getDescriptor(int key)
```
    Retrieve the descriptor when the key is an integer value...
    
    Parameters:
    
    key - The key of the string to use
    
    Returns:
    
    the corresponding descriptor
  - getDescriptor
```
java.lang.String getDescriptor(java.lang.String key)
```
    Retrieve the descriptor when the key is a string
    
    Parameters:
    
    key - The key of the string to use
    
    Returns:
    
    the corresponding descriptor
  - setIsOpen
```
void setIsOpen(boolean value)
```
    Sets the bean to its enabled mode, meaning the editor will be visible to the user
    
    Parameters:
    
    value - boolean value indicating if the instance should be defined as opened (True) or closed (False).
    
    Since:
    
    MicroStrategy Web 8.0.0
  - setHasJustOpened
```
void setHasJustOpened(boolean value)
```
    Sets whether the component has just been opened.
    
    Parameters:
    
    value - hasJustOpend or not
    
    Since:
    
    MicroStrategy Web 8.1.1
  - isOpen
```
boolean isOpen()
```
    Retrieves the open/close state of the bean
    
    Returns:
    
    true if the bean is open and should be visible to end users
    
    Since:
    
    MicroStrategy Web 8.0.0
  - setIsModal
```
void setIsModal(boolean value)
```
    Sets the bean to its modal mode. When true the editor will appear as floating on top of the web page and the user cannot interact with other beans.
    
    Parameters:
    
    value - boolean value indicating if the instance will be handled as Modal (True) or not.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - isModal
```
boolean isModal()
```
    Retrieves the modal state of the bean
    
    Returns:
    
    true if the bean should be treated as modal (i.e., no other beans can interact with the user).
    
    Since:
    
    MicroStrategy Web 8.0.0
  - setIsDialog
```
void setIsDialog(boolean value)
```
    Sets the bean to its dialog mode. When true the editor will appear as floating on top of the web page.
    
    Parameters:
    
    value - boolean value indicating if the instance will be handled as a Dialog (True) or not.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - isDialog
```
boolean isDialog()
```
    Returns true if this bean should be treated as a dialog
    
    Returns:
    
    true if this bean should be treated as a dialog
    
    Since:
    
    MicroStrategy Web 8.0.0
  - setTop
```
void setTop(int y)
```
    Set the top position where the bean should be displayed by the transform if applicable.
    
    Parameters:
    
    y - Coordinate indicating the new top position of the bean
    
    Since:
    
    MicroStrategy Web 8.0.0
  - setLeft
```
void setLeft(int x)
```
    Set the left position where the bean should be displayed by the transform if applicable.
    
    Parameters:
    
    x - Coordinate indicating the new left position of the bean
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getTop
```
int getTop()
```
    Get the top position where the bean should be displayed by the transform if applicable
    
    Returns:
    
    an integer value where the coordinate to use is saved
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getLeft
```
int getLeft()
```
    Get the left position where the bean should be displayed by the transform if applicable
    
    Returns:
    
    an integer value where the coordinate to use is saved
    
    Since:
    
    MicroStrategy Web 8.0.0
  - setExtraUrl
```
void setExtraUrl(java.lang.String newValue)
```
    Set any extra url information to be used when generating link information on the transforms associated with this instance.
    
    Parameters:
    
    newValue - String with any extra url information to use
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getExtraUrl
```
java.lang.String getExtraUrl()
```
    Get any extra url information to be used when generating link information on the transforms associated with this instance.
    
    Returns:
    
    String with any extra url information to use
    
    Since:
    
    MicroStrategy Web 8.0.0
  - setExtraInput
```
void setExtraInput(java.lang.String newValue)
```
    Set any extra input form information to be used when generating form information on the transforms associated with this instance.
    
    Parameters:
    
    newValue - String with any extra input form information to use
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getExtraInput
```
java.lang.String getExtraInput()
```
    Get any extra input form information to be used when generating form information on the transforms associated with this instance.
    
    Returns:
    
    String with any extra input form information to use
    
    Since:
    
    MicroStrategy Web 8.0.0
  - setForcedChildrenStateSaving
```
void setForcedChildrenStateSaving(boolean value)
```
    Forces the bean state to be save despite it's open or closed state.
    
    Since:
    
    MicroStrategy Web 8.1.1
  - isForcedChildrenStateSaving
```
boolean isForcedChildrenStateSaving()
```
    Return whether the state will be save despite it's open or closed state.
    
    Since:
    
    MicroStrategy Web 8.1.1
  - getResultFilterMode
```
int getResultFilterMode()
```
    Since:
    
    MicroStrategy Web 8.1.1
  - isModalOpen
```
boolean isModalOpen()
```
    indicates whether there is a Modal AppComponent open in the hierarchy
    
    Returns:
    
    boolean. true is a Modal AppComponent is open in the hierarchy
    
    Since:
    
    MicroStrategy Web 9.0.1

Interface AppComponent

Field Summary

Method Summary

Methods inherited from interface com.microstrategy.web.beans.Transformable

Methods inherited from interface com.microstrategy.web.beans.WebComponent

Field Detail

COMPONENT_POSITION_NOT_INITIALIZED

Method Detail

getAppContext

getEventManager

getDescriptor

getDescriptor

setIsOpen

setHasJustOpened

isOpen

setIsModal

isModal

setIsDialog

isDialog

setTop

setLeft

getTop

getLeft

setExtraUrl

getExtraUrl

setExtraInput

getExtraInput

setForcedChildrenStateSaving

isForcedChildrenStateSaving

getResultFilterMode

isModalOpen