| com.microstrategy.web.app.beans.AppComponent |
Class Overview
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.
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | COMPONENT_POSITION_NOT_INITIALIZED | Constant indicating the value for the position of the bean has not been specified | |||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract AppContext |
getAppContext()
This method returns the application context object associated with this component.
| ||||||||||
| abstract String |
getDescriptor(String key)
Retrieve the descriptor when the key is a string
| ||||||||||
| abstract String |
getDescriptor(int key)
Retrieve the descriptor when the key is an integer value...
| ||||||||||
| abstract EventManager |
getEventManager()
This method returns the application EventManager used to generates events.
| ||||||||||
| abstract String |
getExtraInput()
Get any extra input form information to be used when generating form information
on the transforms associated with this instance.
| ||||||||||
| abstract String |
getExtraUrl()
Get any extra url information to be used when generating link information
on the transforms associated with this instance.
| ||||||||||
| abstract int |
getLeft()
Get the left position where the bean should be displayed by the transform
if applicable
| ||||||||||
| abstract int | getResultFilterMode() | ||||||||||
| abstract int |
getTop()
Get the top position where the bean should be displayed by the transform
if applicable
| ||||||||||
| abstract boolean |
isDialog()
Returns true if this bean should be treated as a dialog
| ||||||||||
| abstract boolean |
isForcedChildrenStateSaving()
Return whether the state will be save despite it's open or closed state.
| ||||||||||
| abstract boolean |
isModal()
Retrieves the modal state of the bean
| ||||||||||
| abstract boolean |
isModalOpen()
indicates whether there is a Modal AppComponent open in the hierarchy
| ||||||||||
| abstract boolean |
isOpen()
Retrieves the open/close state of the bean
| ||||||||||
| abstract void |
setExtraInput(String newValue)
Set any extra input form information to be used when generating form information
on the transforms associated with this instance.
| ||||||||||
| abstract void |
setExtraUrl(String newValue)
Set any extra url information to be used when generating link information
on the transforms associated with this instance.
| ||||||||||
| abstract void |
setForcedChildrenStateSaving(boolean value)
Forces the bean state to be save despite it's open or closed state.
| ||||||||||
| abstract void |
setHasJustOpened(boolean value)
Sets whether the component has just been opened.
| ||||||||||
| abstract void |
setIsDialog(boolean value)
Sets the bean to its dialog mode.
| ||||||||||
| abstract void |
setIsModal(boolean value)
Sets the bean to its modal mode.
| ||||||||||
| abstract void |
setIsOpen(boolean value)
Sets the bean to its enabled mode, meaning the editor will be
visible to the user
| ||||||||||
| abstract void |
setLeft(int x)
Set the left position where the bean should be displayed by the transform
if applicable.
| ||||||||||
| abstract void |
setTop(int y)
Set the top position where the bean should be displayed by the transform
if applicable.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From interface
com.microstrategy.web.beans.Transformable
| |||||||||||
|
From interface
com.microstrategy.web.beans.WebComponent
| |||||||||||
Constants
public static final int COMPONENT_POSITION_NOT_INITIALIZED
Constant indicating the value for the position of the bean has not been specified
Public Methods
public abstract 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
public abstract String getDescriptor (String key)
Retrieve the descriptor when the key is a string
Parameters
| key | The key of the string to use |
|---|
Returns
- the corresponding descriptor
public abstract 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
public abstract EventManager getEventManager ()
This method returns the application EventManager used to generates events.
Returns
public abstract String getExtraInput ()
Get any extra input form information to be used when generating form information on the transforms associated with this instance.
Returns
Stringwith any extra input form information to use
public abstract String getExtraUrl ()
Get any extra url information to be used when generating link information on the transforms associated with this instance.
Returns
Stringwith any extra url information to use
public abstract 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
public abstract int getResultFilterMode ()
public abstract 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
public abstract boolean isDialog ()
Returns true if this bean should be treated as a dialog
Returns
- true if this bean should be treated as a dialog
public abstract boolean isForcedChildrenStateSaving ()
Return whether the state will be save despite it's open or closed state.
public abstract 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).
public abstract 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
public abstract boolean isOpen ()
Retrieves the open/close state of the bean
Returns
- true if the bean is open and should be visible to end users
public abstract void setExtraInput (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 |
|---|
public abstract void setExtraUrl (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 |
|---|
public abstract void setForcedChildrenStateSaving (boolean value)
Forces the bean state to be save despite it's open or closed state.
public abstract void setHasJustOpened (boolean value)
Sets whether the component has just been opened.
Parameters
| value | hasJustOpend or not |
|---|
public abstract 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. |
|---|
public abstract 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. |
|---|
public abstract 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). |
|---|
public abstract 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 |
|---|
public abstract 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 |
|---|