com.sas.servlet.tbeans
Interface TemplateInterface

All Known Subinterfaces:

CompositeComponentInterface

All Known Implementing Classes:

AbstractSelectorContainer, BarChartComposite, BarLineChartComposite, BaseActionCompositeTransformation, com.sas.servlet.tbeans.BaseActionCompositeTransformation2, BaseCalculatedItemSelectorPanel, BaseCompositeTransformation, com.sas.servlet.tbeans.BaseCompositeTransformation2, BaseDataSelector, BaseDualSelector, BaseExpandCollapse, BaseExpressionEditor, BaseHTMLMenuBar, BaseListEditor, BaseMenu, BaseMenuBar, BaseMenuItem, BaseNavigationBar, BaseRemoteFileSearch, BaseRemoteFileSelector, BaseRemoteFileToolBar, BaseSelectorMenuItem, 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, Menu, MenuBar, MenuItem, NavigationBar, OLAPESRIMapComposite, com.sas.servlet.tbeans.olapgraphics.html.OLAPGraphComposite, OLAPTableViewComposite, OLAPTimeBasedFilterSelector, OLAPTimeBasedFilterSelectorPanel, PercentCalculationsSelector, PercentCalculationsSelectorListBoxView, PercentCalculationsSelectorPanel, PieChartComposite, RadarChartComposite, RemoteFileSearch, RemoteFileSelector, RemoteFileToolBar, ScatterPlotComposite, SelectorMenuBar, SelectorMenuItem, SelectorPanel, ShowDetailDataComposite, SimpleCalculatedItemSelector, SimpleCalculatedItemSelectorPanel, SortSelector, SortSelectorPanel, TableColumnNavigationBar, TableRowNavigationBar, TableViewComposite, TextEntryPropertyEditor, TreeListSelector, WaterfallChartComposite

public interface TemplateInterface

Interface used by all complex components that either use several styles or a composite component that are made up of multiple components.

Method Summary

abstract java.lang.String	getDefaultTemplate() Returns the default template to be used for this composite.
abstract java.lang.String	getTemplate() Returns the template used for a component.
abstract java.util.HashMap	getTemplateDictionary() Returns a user defined template dictionary for the component
abstract java.lang.String	getTemplateFileName() Returns the template file name for the component
abstract java.lang.String	getTemplateLocation() Returns the location the template file should be retrieved from.
abstract void	setTemplate(java.io.File file) Sets a template file object
abstract void	setTemplate(java.lang.String template) Sets the template for this component.
abstract void	setTemplateDictionary(java.util.HashMap dictionary) Sets a user defined dictionary for the component containing variables along with their associated values.
abstract void	setTemplateFileName(java.lang.String template) The name of the template file.
abstract void	setTemplateLocation(java.lang.String location) Sets the location the template file for this composite.

Method Detail

getTemplate

java.lang.String getTemplate()

Returns the template used for a component.

Returns:

a string representing the template on this component. Return null if no template set.

setTemplate

void setTemplate(java.lang.String template)

Sets the template for this component.

Parameters:

a - string that contains keys %SOME_KEY for template substitution

setTemplate

void setTemplate(java.io.File file)

Sets a template file object

Parameters:

file - The file object that contains the template file

setTemplateFileName

void setTemplateFileName(java.lang.String template)

The name of the template file.

Parameters:

template - the file name containing the template

getTemplateFileName

java.lang.String getTemplateFileName()

Returns the template file name for the component

Returns:

the template file name

getTemplateDictionary

java.util.HashMap getTemplateDictionary()

Returns a user defined template dictionary for the component

Returns:

the template dictionary

setTemplateDictionary

void setTemplateDictionary(java.util.HashMap dictionary)

Sets a user defined dictionary for the component containing variables along with their associated values.

Parameters:

a - user defined dictionary

getTemplateLocation

java.lang.String getTemplateLocation()

Returns the location the template file should be retrieved from.

Returns:

the location the template file should be retrieved from

setTemplateLocation

void setTemplateLocation(java.lang.String location)

Sets the location the template file for this composite. If the location is set to null, then the default location as determined by the ComponentPropertyManager will be used.

Parameters:

the - location of the template file

getDefaultTemplate

java.lang.String getDefaultTemplate()

Returns the default template to be used for this composite. If no customized template has been applied and the template file cannot be found or read, this template is used to provide at least a minimum amount of functionality and may or may not have styling or formatting applied to it.

Returns:

default template to be used for this composite