Class AbstractAppComponent
- java.lang.Object
-
- com.microstrategy.utils.serialization.AbstractPersistable
-
- com.microstrategy.web.beans.AbstractTransformable
-
- com.microstrategy.web.beans.AbstractWebComponent
-
- com.microstrategy.web.app.beans.AbstractAppComponent
-
- All Implemented Interfaces:
EnumWebPersistableState
,Persistable
,AppComponent
,Transformable
,WebComponent
- Direct Known Subclasses:
AbstractPersistableAppComponent
,CreditsBean
public abstract class AbstractAppComponent extends AbstractWebComponent implements AppComponent
Title: AbstractAppComponent.
Description: This class provides a skeleton for all
WebComponent
objects implemented in the com.microstrategy.web.app.beans package.These objects represent the different beans available to the application that interact with the web componenets provided by the com.microstrategy.web.beans package. The application web components generaly represent editors, toolbars and containers that aid the user in the presentation and manipulation of web components such as the
ReportBean
,FolderBean
,DocumentBean
, etc. The class' intention is to facilitate the implementation of the application's web components and support the common functionality these objects must provide.Among the methods provided by this class we can find:
- collectData(), responsible for calling the doCollectData() method that should be implemented on each application web component, and cascading down a this invocation to all children on the component's hierarchy.
- setBaseBean(String beanName)/getBaseBean(), where you can indicate the bean, usually a ReportBean or DocumentBean, the application web component is associated with.
- setTargetBean(WebComponent bean)/getTargetBean(), similar to the baseBean property described, but accepts and return the actual instance of the associated web component, not just its name.
- generateOutput(), when called, this call will trigger the rendering of the
web component, using its default transform. A transform can become the bean's
default transform by using the setDefault() method present in the
TransformInstance
interface or by being the first transform set to the web component, either through code or through the pageConfig.xml file.
- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
-
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 AbstractAppComponent()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addChildStateInfo(ParameterBuilder paramBldr)
Adds children state information into an existingParameterBuilder
instance.void
collectData()
Triggers execution to the back end no matter whether it is synchronous or asynchronous.void
collectMinimalData()
Triggers execution to the back end no matter whether it is synchronous or asynchronous.protected boolean
compareChildsTargetWithCurrent()
The implementing class should implement this method to return true if it wants to always call the current object's targetBean#hasChanged method in #hasTargetBeanChanged method.protected TransformInstance
createTransformInstance(Transform transform)
void
doCollectData()
Call the required methods so the data is collected for this instancevoid
doCollectMinimalData()
By default this method simply invokesdoCollectData()
, i.e.MarkupOutput
generateOutput()
Generates the output of a bean.AppContext
getAppContext()
This method returns the application context object associated with this component.java.lang.String
getContactInfo()
Deprecated.Use Preferences.getValue(EnumWebPreferences.WebPreferenceAdminInfo) instead.protected ContainerServices
getContainerServices()
Convenience method to retrieve the connected Container Services object.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 stringEventManager
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.WebFeatures
getFeaturesManager()
Return the WebFeatures implementation associated with this WebComponentint
getLeft()
Get the left position where the bean should be displayed by the transform if applicableprotected WebObjectSource
getObjectSource()
int
getResultFilterMode()
protected WebIServerSession
getSession()
WebComponent
getTargetBean()
Get the target bean associated with this instanceint
getTop()
Get the top position where the bean should be displayed by the transform if applicableint
getType()
Returns the transformable type as inEnumWebTransformableType
.protected WebObjectsFactory
getWebObjectsFactory()
protected static WebObjectsFactory
getWebObjectsFactory(WebBean wb)
Utility method for obtaining aWebObjectsFactory
instanceint
getXMLStatus()
Returns theEnumRequestStatus
status of the component.boolean
hasChanged()
Verifies the state of the component has changedprotected boolean
hasTargetBeanChanged()
When this method is called, we have already checked the children and each of the children has returned with hasChanged() as false.protected boolean
haveChildrenChanged()
protected WebComponent
initComponent(WebComponent bean, java.lang.String suffix)
Initialize a WebComponent as child of this FrameBean.protected void
internalCollectData()
This method is called internally by the transform() method to ensure collectData has been triggered and the bean is ready to transform.boolean
isDialog()
Returns true if this bean should be treated as a dialogboolean
isForcedChildrenStateSaving()
Return wheter the bean's children will be save their states or not despite it's open or closed state.protected boolean
isIFrameRequest()
Utility method that determines if it's an IFrame type of request.boolean
isModal()
The property is used to determine wheter the component will be displayed as a floating (popup) dialog with modal property.boolean
isModalOpen()
indicates whether there is a Modal AppComponent open in the hierarchyboolean
isOpen()
Returns a boolean value indicating if the instance is marked as opened or closed.protected BeanContext
newDefaultBeanContext()
This method is called by getBeanContext() to automatically create an instance of a BeanContext if one has not been explicitly set.protected ParameterBuilder
newHiddenInputBuilder()
Convenience method to retrieve a new instance of a Hidden Input Builder from the connected Container Services object.protected NamespaceEncoder
newNamespaceEncoder()
Convenience method to retrieve a new instance of a Namespace Encoder from the connected Container Services object.protected StyleRequestContext
newStyleRequestContext()
protected ParameterBuilder
newURIBuilder()
Convenience method to retrieve a new instance of a URI Builder from the connected Container Services object.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 to propagate its children to save state despite it's open or closed state.void
setHasJustOpened(boolean value)
Sets whether the component has just been opened.void
setIsDialog(boolean value)
Set method for defining if the instance is to be defined as a Dialog or not.void
setIsModal(boolean value)
Set method for defining if the instance is to be defined as a Modal interface or not.void
setIsOpen(boolean value)
Set the current instance as opened.void
setLeft(int x)
Set the left position where the bean should be displayed by the transform if applicable.void
setOutputFormat(int outputFormat)
Sets the output format ofEnumBeanOutputFormat
for the current WebComponent.void
setTop(int y)
Set the top osition where the bean should be displayed by the transform if applicable.-
Methods inherited from class com.microstrategy.web.beans.AbstractWebComponent
addChild, addChildStateInfo, 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, doFlatState, getStateHandler, isXMLStateZipped, restoreState, restoreXMLState, saveState, saveState, saveState, saveState, 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.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, addChildStateInfo, 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
-
getAppContext
public AppContext getAppContext()
This method returns the application context object associated with this component. To set this context, useWebComponent.setBeanContext(com.microstrategy.web.beans.BeanContext)
passing in an application context object.- Specified by:
getAppContext
in interfaceAppComponent
- Returns:
AppContext
-
newDefaultBeanContext
protected BeanContext newDefaultBeanContext()
Description copied from class:AbstractTransformable
This method is called by getBeanContext() to automatically create an instance of a BeanContext if one has not been explicitly set.- Overrides:
newDefaultBeanContext
in classAbstractTransformable
- Since:
- MicroStrategy Web 9.0.0
-
getXMLStatus
public int getXMLStatus()
Returns theEnumRequestStatus
status of the component. The status determined by by the status of its children with the following precedence.EnumRequestStatus.WebBeanRequestEndsInError
EnumRequestStatus.WebBeanRequestCanceled
EnumRequestStatus.WebBeanRequestProcessing
EnumRequestStatus.WebBeanRequestNotInitiated
EnumRequestStatus.WebBeanRequestWaitingForUserInput
EnumRequestStatus.WebBeanRequestSuccessful
- Specified by:
getXMLStatus
in interfaceWebComponent
- Returns:
- an
EnumRequestStatus
enumeration value for the component.
-
internalCollectData
protected void internalCollectData() throws WebBeanException
This method is called internally by the transform() method to ensure collectData has been triggered and the bean is ready to transform.- Overrides:
internalCollectData
in classAbstractTransformable
- Throws:
WebBeanException
- thrown if there is severe errors when collecting data- See Also:
AbstractTransformable.internalCollectData(boolean)
-
generateOutput
public MarkupOutput generateOutput()
Generates the output of a bean. It transforms the bean- Specified by:
generateOutput
in interfaceWebComponent
- Returns:
- the bean's output
-
doCollectData
public void doCollectData()
Call the required methods so the data is collected for this instance- Since:
- MicroStrategy Web 8.0.0
-
doCollectMinimalData
public void doCollectMinimalData()
By default this method simply invokes
doCollectData()
, i.e. by default it will retrieve as much data asdoCollectData()
is defined to do so. It is strongly recommended to override this method, and provide an implementation that retrieves the minimal amount of data.The purpose of this method is to allow this component to be subjected to the normal workflow, but not entail retrieving any more than the minimal amount of data.
For example, there are scenarios when a change is made on a page, but the user then temporarily switches to another page before returning to the original page. While the user is on the other page, we can perform a minimal collect data of the components from the original page since we would not need the data.
- Since:
- MicroStrategy Web 9.0.0
-
collectData
public void collectData() throws WebBeanException
Triggers execution to the back end no matter whether it is synchronous or asynchronous. If this method fails to collect data, an exception is raised and saved in a WebBeanError instance. IfisOpen()
, this method will first perform adoCollectData()
, then proceeds to callcollectData()
on all child componentsAbstractWebComponent.getChild(int)
.- Specified by:
collectData
in interfaceWebComponent
- Overrides:
collectData
in classAbstractWebComponent
- Throws:
WebBeanException
- thrown if there is any exception
-
collectMinimalData
public void collectMinimalData() throws WebBeanException
Triggers execution to the back end no matter whether it is synchronous or asynchronous. If this method fails to collect data, an exception is raised and saved in a WebBeanError instance. IfisOpen()
, this method will first perform adoCollectMinimalData()
, then proceeds to callcollectMinimalData()
on all child componentsAbstractWebComponent.getChild(int)
.- Specified by:
collectMinimalData
in interfaceWebComponent
- Overrides:
collectMinimalData
in classAbstractWebComponent
- Throws:
WebBeanException
- thrown if an error occurs during this operation.- Since:
- MicroStrategy Web 9.0.0
-
getContactInfo
public java.lang.String getContactInfo()
Deprecated.Use Preferences.getValue(EnumWebPreferences.WebPreferenceAdminInfo) instead.Returns the administrator contact info as defined in theEnumWebPreferences.WebPreferenceAdminInfo
preferences. If the preference is null or the beanContext is not set, it returns an empty string.- Returns:
- The admin contact info.
-
getDescriptor
public java.lang.String getDescriptor(int key)
Retrieve the descriptor when the key is an integer value...- Specified by:
getDescriptor
in interfaceAppComponent
- Parameters:
key
- The key of the string to use- Returns:
- the corresponding descriptor
-
getDescriptor
public java.lang.String getDescriptor(java.lang.String key)
Retrieve the descriptor when the key is a string- Specified by:
getDescriptor
in interfaceAppComponent
- Parameters:
key
- The key of the string to use- Returns:
- the corresponding descriptor
-
getType
public int getType()
Returns the transformable type as inEnumWebTransformableType
.- Specified by:
getType
in interfaceTransformable
- Returns:
- the transformable type.
-
getEventManager
public EventManager getEventManager()
This method returns the application EventManager used to generates events.- Specified by:
getEventManager
in interfaceAppComponent
- Returns:
EventManager
-
getWebObjectsFactory
protected static WebObjectsFactory getWebObjectsFactory(WebBean wb)
Utility method for obtaining aWebObjectsFactory
instance- Parameters:
wb
-WebBean
from where the factory is to be obtained.- Returns:
WebObjectsFactory
initialized instance.
-
isIFrameRequest
protected boolean isIFrameRequest()
Utility method that determines if it's an IFrame type of request.- Returns:
boolean
value indicating if the request is of type IFrame or not. By default it is based only on information available on theRequestKeys
associated with this instance.
-
setExtraUrl
public 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.- Specified by:
setExtraUrl
in interfaceAppComponent
- Parameters:
newValue
-String
with any extra url information to use
-
getExtraUrl
public java.lang.String getExtraUrl()
Get any extra url information to be used when generating link information on the transforms associated with this instance.- Specified by:
getExtraUrl
in interfaceAppComponent
- Returns:
String
with any extra url information to use
-
setExtraInput
public 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.- Specified by:
setExtraInput
in interfaceAppComponent
- Parameters:
newValue
-String
with any extra input form information to use
-
getExtraInput
public java.lang.String getExtraInput()
Get any extra input form information to be used when generating form information on the transforms associated with this instance.- Specified by:
getExtraInput
in interfaceAppComponent
- Returns:
String
with any extra input form information to use
-
setHasJustOpened
public void setHasJustOpened(boolean value)
Sets whether the component has just been opened.- Specified by:
setHasJustOpened
in interfaceAppComponent
- Parameters:
value
- hasJustOpend or not- Since:
- MicroStrategy Web 8.1.1
- See Also:
AppComponent.setHasJustOpened(boolean)
-
setIsOpen
public void setIsOpen(boolean value)
Set the current instance as opened. This method will have no effect if the instance is defined as a dialog (isDialog()
property should returnFalse
).- Specified by:
setIsOpen
in interfaceAppComponent
- 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()
Returns a boolean value indicating if the instance is marked as opened or closed.- Specified by:
isOpen
in interfaceAppComponent
- Returns:
boolean
value ofTrue
if the instance is marked as opened, it will returnFalse
otherwise. By default, instances not marked as dialogs (isDialog()
property returning False) will have a browser setting associated with them that should indicate if they are opened or closed. The parent hierarchy is also tested to be in opened state as well as dependent beans not to be in error.- Since:
- MicroStrategy Web 8.0.0
-
isDialog
public boolean isDialog()
Description copied from interface:AppComponent
Returns true if this bean should be treated as a dialog- Specified by:
isDialog
in interfaceAppComponent
- Returns:
boolean
value indicating if the instance has been defined as a Dialog or not.- Since:
- MicroStrategy Web 8.0.0
-
setIsDialog
public void setIsDialog(boolean value)
Set method for defining if the instance is to be defined as a Dialog or not.- Specified by:
setIsDialog
in interfaceAppComponent
- Parameters:
value
-boolean
value indicating if the instance will be handled as a Dialog (True
) or not.- Since:
- MicroStrategy Web 8.0.0
-
setIsModal
public void setIsModal(boolean value)
Set method for defining if the instance is to be defined as a Modal interface or not. By default, if the instance is marked as Modal, it will also be defined as a Dialog.- Specified by:
setIsModal
in interfaceAppComponent
- Parameters:
value
-boolean
value indicating if the instance will be handled as Modal (True
) or not.- Since:
- MicroStrategy Web 8.0.0
-
isModal
public boolean isModal()
The property is used to determine wheter the component will be displayed as a floating (popup) dialog with modal property. When a modal dialog is open the user will not be able to click anywehre in the interface other that the dialog until the dialog is cloesed. the- Specified by:
isModal
in interfaceAppComponent
- Returns:
boolean
value indicating if the instance has been defined as a Modal interface (True
) or not.- Since:
- MicroStrategy Web 8.0.0
-
getTargetBean
public WebComponent getTargetBean()
Get the target bean associated with this instance- Specified by:
getTargetBean
in interfaceWebComponent
- Overrides:
getTargetBean
in classAbstractWebComponent
- Returns:
WebComponent
instance associated with this bean. By default if the base bean property has been defined, the target bean to return is the corresponding instance associated with the name and path specified. If nothing has been specified then it will return the firstEnumWebTransformableType.WEB_BEAN_REPORT
,EnumWebTransformableType.WEB_BEAN_DOCUMENT
orEnumWebTransformableType.WEB_BEAN_RW
instance found.- Since:
- MicroStrategy Web 8.0.0
-
setLeft
public void setLeft(int x)
Set the left position where the bean should be displayed by the transform if applicable.- Specified by:
setLeft
in interfaceAppComponent
- Parameters:
x
- Coordinate indicating the new left position of the bean- Since:
- MicroStrategy Web 8.0.0
-
setTop
public void setTop(int y)
Set the top osition where the bean should be displayed by the transform if applicable.- Specified by:
setTop
in interfaceAppComponent
- Parameters:
y
- Coordinate indicating the new top position of the bean- Since:
- MicroStrategy Web 8.0.0
-
getLeft
public int getLeft()
Get the left position where the bean should be displayed by the transform if applicable- Specified by:
getLeft
in interfaceAppComponent
- Returns:
- integer where the coordinate to use is saved
- Since:
- MicroStrategy Web 8.0.0
-
getTop
public int getTop()
Get the top position where the bean should be displayed by the transform if applicable- Specified by:
getTop
in interfaceAppComponent
- Returns:
- integer where the coordinate to use is saved
- Since:
- MicroStrategy Web 8.0.0
-
hasChanged
public boolean hasChanged()
Description copied from class:AbstractWebComponent
Verifies the state of the component has changed- Specified by:
hasChanged
in interfaceWebComponent
- Overrides:
hasChanged
in classAbstractWebComponent
- Returns:
boolean
value indicating if the current instance or its base bean (if any defined) has been marked as changed.- Since:
- MicroStrategy Web 8.0.0
-
haveChildrenChanged
protected boolean haveChildrenChanged()
- Overrides:
haveChildrenChanged
in classAbstractWebComponent
- Since:
- MicroStrategy Web 9.0.0
-
hasTargetBeanChanged
protected boolean hasTargetBeanChanged()
When this method is called, we have already checked the children and each of the children has returned with hasChanged() as false. If #compareChildsTargetWithCurrent method returns true, then we check if any of the child's target bean is same as this object's target bean and return true if this is the case. If you want to check the targetbean of this component, then override compareChildsTargetWithCurrent to return true- Since:
- MicroStrategy Web 9.0.0
-
compareChildsTargetWithCurrent
protected boolean compareChildsTargetWithCurrent()
The implementing class should implement this method to return true if it wants to always call the current object's targetBean#hasChanged method in #hasTargetBeanChanged method.- Returns:
- a boolean to compare the children's target with the current target.
- Since:
- MicroStrategy Web 9.0.0
-
getFeaturesManager
public WebFeatures getFeaturesManager()
Return the WebFeatures implementation associated with this WebComponent- Specified by:
getFeaturesManager
in interfaceWebComponent
- Overrides:
getFeaturesManager
in classAbstractWebComponent
- Returns:
- a WebFeatures instance
- Since:
- MicroStrategy Web 8.0.0
-
setOutputFormat
public void setOutputFormat(int outputFormat)
Sets the output format ofEnumBeanOutputFormat
for the current WebComponent.- Specified by:
setOutputFormat
in interfaceWebComponent
- Overrides:
setOutputFormat
in classAbstractWebComponent
- Parameters:
outputFormat
- the output format ofEnumBeanOutputFormat
.- Since:
- MicroStrategy Web 8.0.0
-
setForcedChildrenStateSaving
public void setForcedChildrenStateSaving(boolean value)
Forces the bean to propagate its children to save state despite it's open or closed state. However whether to save its own state or not is up to individual children bean to decide.- Specified by:
setForcedChildrenStateSaving
in interfaceAppComponent
- Since:
- MicroStrategy Web 8.1.1
-
isForcedChildrenStateSaving
public boolean isForcedChildrenStateSaving()
Return wheter the bean's children will be save their states or not despite it's open or closed state. However whether to save its own state or not is up to individual children bean to decide.- Specified by:
isForcedChildrenStateSaving
in interfaceAppComponent
- Since:
- MicroStrategy Web 8.1.1
-
addChildStateInfo
public void addChildStateInfo(ParameterBuilder paramBldr)
Description copied from interface:WebComponent
Adds children state information into an existingParameterBuilder
instance. It is up to the suppliedParameterBuilder
to determine how this information is serialized. EachWebComponent
the hierarchy serializes its state according to its ownWebComponent.getDefaultStateLevel()
.- Specified by:
addChildStateInfo
in interfaceWebComponent
- Overrides:
addChildStateInfo
in classAbstractWebComponent
- Parameters:
paramBldr
- TheParameterBuilder
instance which has child state information added to it.- Since:
- MicroStrategy Web 9.0.0
-
isModalOpen
public boolean isModalOpen()
indicates whether there is a Modal AppComponent open in the hierarchy- Specified by:
isModalOpen
in interfaceAppComponent
- Returns:
boolean
. true is a Modal AppComponent is open in the hierarchy- Since:
- MicroStrategy Web 9.0.1
-
getContainerServices
protected ContainerServices getContainerServices()
Convenience method to retrieve the connected Container Services object. If anything fails along the way, returns null.- Returns:
- The ContainerServices instance.
- Since:
- MicroStrategy Web 8.0.0
-
newURIBuilder
protected ParameterBuilder newURIBuilder()
Convenience method to retrieve a new instance of a URI Builder from the connected Container Services object. If anything fails along the way, returns null.- Returns:
- The ParameterBuilder instance to use for building URIs.
- Since:
- MicroStrategy Web 8.0.0
-
newHiddenInputBuilder
protected ParameterBuilder newHiddenInputBuilder()
Convenience method to retrieve a new instance of a Hidden Input Builder from the connected Container Services object. If anything fails along the way, returns null.- Returns:
- The ParameterBuilder instance to use for building Hidden Input strings.
- Since:
- MicroStrategy Web 8.0.0
-
newNamespaceEncoder
protected NamespaceEncoder newNamespaceEncoder()
Convenience method to retrieve a new instance of a Namespace Encoder from the connected Container Services object. If anything fails along the way, returns null.- Returns:
- The NamespaceEncoder instance to use for encoding names.
- Since:
- MicroStrategy Web 8.0.0
-
getResultFilterMode
public int getResultFilterMode()
- Specified by:
getResultFilterMode
in interfaceAppComponent
- Since:
- MicroStrategy Web 8.1.1
-
initComponent
protected WebComponent initComponent(WebComponent bean, java.lang.String suffix)
Initialize a WebComponent as child of this FrameBean. It inherits common properties, such as BeanContext, and output format. It also adds it as a child- Parameters:
bean
- The bean to initializesuffix
- the name to add to the bean. This name will be prefixed with the name of the bean- Returns:
- the same bean, but now initialized.
- Since:
- MicroStrategy Web 9.0.0
-
getSession
protected WebIServerSession getSession()
- Since:
- MicroStrategy Web 9.0.0
-
getWebObjectsFactory
protected WebObjectsFactory getWebObjectsFactory()
- Since:
- MicroStrategy Web 9.0.0
-
getObjectSource
protected WebObjectSource getObjectSource()
- Since:
- MicroStrategy Web 9.0.0
-
newStyleRequestContext
protected StyleRequestContext newStyleRequestContext()
- Overrides:
newStyleRequestContext
in classAbstractWebComponent
- Since:
- MicroStrategy Web 9.0.0
-
createTransformInstance
protected TransformInstance createTransformInstance(Transform transform)
- Overrides:
createTransformInstance
in classAbstractTransformable
- Since:
- MicroStrategy Web 9.0.1
-
-