public interface

AttributeFormsEditorBean

implements ReportFrameElement ViewBeanParserBean
com.microstrategy.web.app.beans.AttributeFormsEditorBean
Known Indirect Subclasses

Class Overview

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(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.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract Vector getAttFormsVector()
Returns a Vector with the list of attribute forms for the selected attribute
abstract WebAttribute getAttribute()
Returns the attribute contained in the bean, which was initialized with the attributeId property.
abstract WebAttributeForms getAttributeForms()
Returns the WebAttributeForms for the currently selected Attribute
abstract String getAttributeId()
Returns The ID of the Attribute to select on the Attribute Forms Editor
abstract ArrayList getAttributeList()
Returns an ArrayList the list of Attributes
abstract WebAttribute getSelectedAttribute()
Returns the WebAttribute currently selected
abstract boolean getShowAttributeList()
Whether to display the list of attributes on the Attribute Forms Editor
abstract void reset()
Initializes the bean by clearing the selected Attribute as well as the list of Attribute Forms
abstract void setAttributeId(String attributeId)
Sets the ID of the Attribute to select on the Attribute Forms Editor.
abstract void setShowAttributeList(boolean showAttributeList)
Whether to display the list of attributes on the Attribute Forms Editor
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.FrameElement
From interface com.microstrategy.web.app.beans.ReportFrameElement
From interface com.microstrategy.web.app.beans.ViewBeanParserBean
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract Vector getAttFormsVector ()

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

public abstract WebAttribute getAttribute ()

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

Returns

public abstract WebAttributeForms getAttributeForms ()

Returns the WebAttributeForms for the currently selected Attribute

Returns
  • WebAttributeForms the available attribute forms for the selected attribute.

public abstract String getAttributeId ()

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

public abstract ArrayList getAttributeList ()

Returns an ArrayList the list of Attributes

public abstract WebAttribute getSelectedAttribute ()

Returns the WebAttribute currently selected

public abstract 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.

public abstract void reset ()

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

public abstract void setAttributeId (String attributeId)

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

Parameters
attributeId String with the corresponding ID.

public abstract 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.