com.sas.servlet.tbeans.graphics.html
Class BaseGraphSupport

com.sas.servlet.tbeans.graphics.html.BaseGraphSupport

All Implemented Interfaces:

FormViewInterface

Direct Known Subclasses:

GraphSupport

public class BaseGraphSupport
implements FormViewInterface

Constructor Summary

BaseGraphSupport(com.sas.servlet.tbeans.graphics.BaseGraph baseGraph)
Base Graph support routines.

Method Summary

java.util.HashMap	getAdditionalParameters() Returns an HashMap containing additional parameters that should be added to the form used to perform the various actions on the table.
Form	getDefaultFormObject() Returns the FORM object used if no FORM object is specifed.
Form	getFormObject() Returns the FORM Object used to execute commands.
com.sas.util.SimpleTemplate	getURLTemplate() Returns the Viewer's URLTemplate.
boolean	isFormEnabled() Determines if the tbean should render its formObject.
void	setAdditionalParameter(java.lang.String name, java.lang.String value) Sets an additional parameter to be added to the form used to perform the various actions on the table.
void	setAdditionalParameters(java.util.HashMap map) Sets an HashMap containing additional parameters that should be added to the form used to perform the various actions on the table.
void	setFormEnabled(boolean value) Sets whether the tbean should render its formObject.
void	setFormObject(Form formObject) Returns the FORM Object used to execute commands.
void	setURLTemplate(com.sas.util.SimpleTemplate newURLTemplate) Sets the Viewer's URLTemplate.
void	write(java.io.PrintWriter out)

Constructor Detail

BaseGraphSupport

public BaseGraphSupport(com.sas.servlet.tbeans.graphics.BaseGraph baseGraph)

Base Graph support routines.

Method Detail

getDefaultFormObject

public Form getDefaultFormObject()

Returns the FORM object used if no FORM object is specifed.

Specified by:

getDefaultFormObject in interface FormViewInterface

Returns:

FORM object

See Also:

getFormObject()

getFormObject

public Form getFormObject()

Returns the FORM Object used to execute commands.

Specified by:

getFormObject in interface FormViewInterface

Returns:

FORM object

See Also:

setFormObject(Form)

setFormObject

public void setFormObject(Form formObject)

Returns the FORM Object used to execute commands.

Specified by:

setFormObject in interface FormViewInterface

Parameters:

formObject - FORM object

See Also:

getFormObject()

getAdditionalParameters

public java.util.HashMap getAdditionalParameters()

Returns an HashMap containing additional parameters that should be added to the form used to perform the various actions on the table. The default value is null. In the html version, each parameter will be added to the form as a hidden field using the name of the item as the name= parameter on the <input> tag and the value of the item as the value= parameter on the input tag.

Specified by:

getAdditionalParameters in interface FormViewInterface

Returns:

a HashMap containing additional parameters that should be added to the form

See Also:

HashMap

setAdditionalParameters

public void setAdditionalParameters(java.util.HashMap map)

Sets an HashMap containing additional parameters that should be added to the form used to perform the various actions on the table. The default value is null. In the html version, each parameter will be added to the form as a hidden field using the name of the item as the name= parameter on the <input> tag and the value of the item as the value= parameter on the input tag.

Specified by:

setAdditionalParameters in interface FormViewInterface

Parameters:

map - HashMap object

See Also:

HashMap

setAdditionalParameter

public void setAdditionalParameter(java.lang.String name,
                                   java.lang.String value)

Sets an additional parameter to be added to the form used to perform the various actions on the table. In the html version, Each parameter will be added to the form as a hidden field using the name of the item as the name= parameter on the <input> tag and the value of the item as the value= parameter on the input tag.

Specified by:

setAdditionalParameter in interface FormViewInterface

Parameters:

name - name of the list item

value - value of the list item

See Also:

HashMap

isFormEnabled

public boolean isFormEnabled()

Determines if the tbean should render its formObject. If true, then the tbean is responsible for rendering the formObject via the formObject's writeHeader and writeFooter methods. If false then the tbean does not render the formObject and the user is responsible for rendering the formObject.

Specified by:

isFormEnabled in interface FormViewInterface

Returns:

true if the tbean should render its formObject

setFormEnabled

public void setFormEnabled(boolean value)

Sets whether the tbean should render its formObject. If so, then set to true. If set to false, the the user is responsible for rendering the formObject via its writeHeader and writeFooter methods.

Specified by:

setFormEnabled in interface FormViewInterface

Parameters:

value - true if the formObject should be rendered by the tbean

write

public void write(java.io.PrintWriter out)
           throws java.io.IOException

Throws:

java.io.IOException

setURLTemplate

public void setURLTemplate(com.sas.util.SimpleTemplate newURLTemplate)

Sets the Viewer's URLTemplate. A template is needed if the viewer submits actions via a form. The template defines a call to the javascript function that feeds the form.

Parameters:

newURLTemplate - the Viewer's URLTemplate

getURLTemplate

public com.sas.util.SimpleTemplate getURLTemplate()

Returns the Viewer's URLTemplate.

Returns:

the Viewer's URLTemplate