com.sas.servlet.tbeans
Interface CompositeComponentInterface

All Superinterfaces:

TemplateInterface

All Known Implementing Classes:

AbstractSelectorContainer, BarChartComposite, BarLineChartComposite, BaseActionCompositeTransformation, com.sas.servlet.tbeans.BaseActionCompositeTransformation2, BaseCalculatedItemSelectorPanel, BaseCompositeTransformation, com.sas.servlet.tbeans.BaseCompositeTransformation2, BaseDataSelector, BaseDualSelector, BaseExpandCollapse, BaseExpressionEditor, BaseListEditor, BaseNavigationBar, BaseRemoteFileSearch, BaseRemoteFileSelector, BaseRemoteFileToolBar, BaseSelectorPanel, CheckBoxListPropertyEditor, DataSelector, DataSelectorListBoxView, DualListSelector, DualSelector, DualTreeSelector, EntityAttributeValueSelector, EntityAttributeValueSelectorPanel, ESRIMapComposite, ExceptionHighlightingChartSelector, ExceptionHighlightingChartSelectorPanel, ExceptionHighlightingSelector, ExceptionHighlightingSelectorPanel, ExpandCollapse, ExportSelector, ExportSelectorPanel, FilterAndRankSelector, FilterAndRankSelectorPanel, FindSelector, FindSelectorPanel, GraphComposite, InformationServicesSearch, InformationServicesSelector, LineChartComposite, LinePlotComposite, ListBoxViewPropertyEditor, ListEditor, MapCrossingSelector, MapCrossingSelectorPanel, MapPropertySelector, MapPropertySelectorPanel, MemberPropertiesSelector, MemberPropertiesSelectorPanel, NavigationBar, OLAPESRIMapComposite, com.sas.servlet.tbeans.olapgraphics.html.OLAPGraphComposite, OLAPTableViewComposite, OLAPTimeBasedFilterSelector, OLAPTimeBasedFilterSelectorPanel, PercentCalculationsSelector, PercentCalculationsSelectorListBoxView, PercentCalculationsSelectorPanel, PieChartComposite, RadarChartComposite, RemoteFileSearch, RemoteFileSelector, RemoteFileToolBar, ScatterPlotComposite, SelectorPanel, ShowDetailDataComposite, SimpleCalculatedItemSelector, SimpleCalculatedItemSelectorPanel, SortSelector, SortSelectorPanel, TableColumnNavigationBar, TableRowNavigationBar, TableViewComposite, TextEntryPropertyEditor, TreeListSelector, WaterfallChartComposite

public interface CompositeComponentInterface
extends TemplateInterface

Interface used by all composite components that are made up of multiple components.

Method Summary

TransformationInterface	getComponent(java.lang.String componentKey) Returns a reference to a component, based on the component key.
java.util.Map	getComponents() Returns a map with all the components in the composite in it.
StyleInfo	getStyleInfo(java.lang.String componentKey, java.lang.String styleAreaKey) Returns the StyleInfo object for a component/style area.
java.util.Map	getVisibleComponents() Returns a Map containing all the components in the composite where isVisible() returns true.
TransformationInterface	removeComponent(java.lang.String componentKey) Removes a component from the list of components contained in the composite component.
TransformationInterface	setComponent(java.lang.String componentKey, TransformationInterface tbean) Adds a component to the list of components contained in the composite component.
void	setStyleInfo(java.lang.String componentKey, java.lang.String styleAreaKey, StyleInfo styleInfo) Assigns a StyleInfo object to the appropriate style area.

Methods inherited from interface com.sas.servlet.tbeans.TemplateInterface

getDefaultTemplate, getTemplate, getTemplateDictionary, getTemplateFileName, getTemplateLocation, setTemplate, setTemplate, setTemplateDictionary, setTemplateFileName, setTemplateLocation

Method Detail

setComponent

TransformationInterface setComponent(java.lang.String componentKey,
                                     TransformationInterface tbean)

Adds a component to the list of components contained in the composite component. Components .must all have a unique componentKey. ComponentKeys are defined for complex and composite components in com.sas.servlet.tbeans.component-name.component-nameKeysInterface.

Parameters:

tbean - Transformation Bean.

componentKey - unique component keys.

Returns:

the object that was added if successful or null if the add is unsuccessful.

removeComponent

TransformationInterface removeComponent(java.lang.String componentKey)

Removes a component from the list of components contained in the composite component.

Parameters:

componentKey - unique component key.

Returns:

TransformationInterface object if successful null if unsuccessful

getStyleInfo

StyleInfo getStyleInfo(java.lang.String componentKey,
                       java.lang.String styleAreaKey)
                       throws java.lang.NullPointerException

Returns the StyleInfo object for a component/style area. StyleKeys are defined for complex and composite components in com.sas.servlet.tbeans.component-name.component-name.html.component-nameStyleKeysInterface.

Parameters:

componentKey - key to access the appropriate component

styleAreKey - key to identify the style area. styleArea keys are defined for each component.

Returns:

StyleInfo object

Throws:

java.lang.NullPointerException - Thrown if some type of null pointer error occurs

setStyleInfo

void setStyleInfo(java.lang.String componentKey,
                  java.lang.String styleAreaKey,
                  StyleInfo styleInfo)
                  throws java.lang.NullPointerException

Assigns a StyleInfo object to the appropriate style area. StyleKeys are defined for complex and composite components in com.sas.servlet.tbeans.component-name.component-name.html.component-nameStyleKeysInterface.

Parameters:

componentKey - key to access the appropriate component,

styleAreaKey - key to identify the style area

styleInfo - the StyleInfo object

Throws:

java.lang.NullPointerException - Thrown if some type of null pointer error occurs

getComponents

java.util.Map getComponents()

Returns a map with all the components in the composite in it.

Returns:

map will all the components in it.

getComponent

TransformationInterface getComponent(java.lang.String componentKey)

Returns a reference to a component, based on the component key.

Parameters:

componentKey - key to access the appropriate component

Returns:

TransformationInterface object if successful

getVisibleComponents

java.util.Map getVisibleComponents()

Returns a Map containing all the components in the composite where isVisible() returns true.

Returns:

a Map containing all visible components.