Package com.microstrategy.web.app.beans

Interface AttributeFormsEditorBean

All Superinterfaces:

AppComponent, EnumWebPersistableState, FrameElement, Persistable, ReportFrameElement, RequestPersistable, Transformable, ViewBeanParserBean, WebComponent

All Known Subinterfaces:

AttributeFormsQualificationBean

All Known Implementing Classes:

AttributeFormsQualificationBeanImpl

public interface AttributeFormsEditorBean
extends ReportFrameElement, ViewBeanParserBean

This editor is used to modify the the available forms of an attribute in a report.

For each attribute in the report's working set, the user can select the forms that are available to add to the grid, and from those the ones that should actually be displayed.

This editor provides the attribute forms list of a given attribute. The corresponding attribute is selected by calling setAttributeId(java.lang.String). The method getAttributeForms() returns this list.

It also provides a helper method getAttributeList() to retrieve the list of attributes available in the working set.

Sometimes the user might be able to select the attribute to edit from the list of attributes in the working set, but sometimes s/he won't. This is the intention of getShowAttributeList(). Notice that this can be changed at runtime through the setShowAttributeList(boolean) method. When this happens the new value is automatically saved as part of the bean's state.

Since:

MicroStrategy Web 8.0.0

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

Modifier and Type	Method	Description
java.util.Vector	getAttFormsVector()	Returns a Vector with the list of attribute forms for the selected attribute
WebAttribute	getAttribute()	Returns the attribute contained in the bean, which was initialized with the attributeId property.
WebAttributeForms	getAttributeForms()	Returns the WebAttributeForms for the currently selected Attribute
java.lang.String	getAttributeId()	Returns The ID of the Attribute to select on the Attribute Forms Editor
java.util.ArrayList	getAttributeList()	Returns an ArrayList the list of Attributes
WebAttribute	getSelectedAttribute()	Returns the WebAttribute currently selected
boolean	getShowAttributeList()	Whether to display the list of attributes on the Attribute Forms Editor
void	reset()	Initializes the bean by clearing the selected Attribute as well as the list of Attribute Forms
void	setAttributeId(java.lang.String attributeId)	Sets the ID of the Attribute to select on the Attribute Forms Editor.
void	setShowAttributeList(boolean showAttributeList)	Whether to display the list of attributes on the Attribute Forms Editor

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.web.app.beans.FrameElement

getFrameBean, getTargetBean, getTargetBeanPath, getUseIFrame, isEditor, isEnabled, setTargetBean, setTargetBeanPath, setUseIFrame

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.app.beans.ReportFrameElement

getReportFrameBean, isGridDataNecessary

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.app.beans.ViewBeanParserBean

getActiveElementIndex, getActiveViewKey, getTemplateElementList, getViewBean, getViewBean, setActiveElementIndex, setActiveViewKey

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

getAttFormsVector

java.util.Vector getAttFormsVector()

Returns a Vector with the list of attribute forms for the selected attribute

getSelectedAttribute

WebAttribute getSelectedAttribute()

Returns the WebAttribute currently selected

getAttributeList

java.util.ArrayList getAttributeList()

Returns an ArrayList the list of Attributes

setAttributeId

void setAttributeId(java.lang.String attributeId)

Sets the ID of the Attribute to select on the Attribute Forms Editor.

Parameters:

attributeId - String with the corresponding ID.

getAttributeId

java.lang.String getAttributeId()

Returns The ID of the Attribute to select on the Attribute Forms Editor

setShowAttributeList

void setShowAttributeList(boolean showAttributeList)

Whether to display the list of attributes on the Attribute Forms Editor

Parameters:

showAttributeList - true if the list of attributes should be displayed.

getShowAttributeList

boolean getShowAttributeList()

Whether to display the list of attributes on the Attribute Forms Editor

Returns:

boolean true if the list of attributes should be displayed.

reset

void reset()

Initializes the bean by clearing the selected Attribute as well as the list of Attribute Forms

getAttribute

WebAttribute getAttribute()

Returns the attribute contained in the bean, which was initialized with the attributeId property.

Returns:

A WebAttribute contained in the bean.

getAttributeForms

WebAttributeForms getAttributeForms()

Returns the WebAttributeForms for the currently selected Attribute

Returns:

WebAttributeForms the available attribute forms for the selected attribute.