com.sas.servlet.tbeans
Class BaseActionTransformation

com.sas.servlet.tbeans.BaseActionTransformation

All Implemented Interfaces:

ActionProviderViewInterface, HttpActionProviderInterface, HttpActionProviderViewInterface, com.sas.beans.PropertyChangeSource, com.sas.lang.ObjectDataInterface, RenderableInterface, TransformationInterface, com.sas.util.WriteToPrintWriterInterface, java.io.Serializable

Direct Known Subclasses:

com.sas.servlet.tbeans.BaseActionTransformation2, com.sas.servlet.tbeans.graphics.BaseGraphics, BaseLabel

public abstract class BaseActionTransformation
implements HttpActionProviderViewInterface

See Also:

Serialized Form

Constructor Summary

BaseActionTransformation()
Default constructor.

Method Summary

void	dispose() This method exists for consumers to call when they are done with a component to ensure that the HttpActionProvider is cleared of all references to and for the component.
HttpActionProvider	getActionProvider() Returns the HttpActionProvider object
java.lang.String	getActionSupportType() Return the key that associated with a particular support class in the ActionProvider framework.
java.lang.Object	getUniqueId() Returns the Viewer's uniqueId
boolean	isActionVisible(java.lang.String actionType, java.lang.String areaType) Returns a boolean indicating if the action type is visible everywhere in the specified areaType.
java.util.Collection	listActionTypes(java.lang.String areaType) Returns a Collection of String keys that define the valid actionTypes for the specified area of the action support class designated the actionSupportType attribute.
java.util.Collection	listAreaTypes() Returns a Collection of String keys that define the valid areaTypes for the action support class designated by the actionSupportType attribute.
void	setActionProvider(HttpActionProvider provider) Sets the HttpActionProvider object
void	setActionSupportType(java.lang.String actionSupportType) Set the key that associated with a particular support class in the ActionProvider framework.
void	setActionVisible(java.lang.String actionType, java.lang.String areaType, boolean visible) Sets the visible status of the specified actionType for the specified area.
void	setUniqueId(java.lang.Object uniqueId) Sets the Viewer's uniqueId
void	write(java.io.PrintWriter out) Writes the custom attributes of the object.

Methods inherited from class com.sas.servlet.tbeans.BaseTransformation

addPropertyChangeListener, addPropertyChangeListener, cleanUpResources, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCustomAttributes, getDescription, getId, getInputTransform, getLocale, getName, getObjectData, getObjectDataProperty, getOutputTransform, getRequest, getResponse, getTagEpilog, getTagProlog, hasListeners, isCleanUpResourcesOn, isVisible, removePropertyChangeListener, removePropertyChangeListener, setCleanUpResourcesOn, setCustomAttributes, setDescription, setId, setInputTransform, setLocale, setLocaleDependentProperties, setName, setObjectData, setObjectDataProperty, setOutputTransform, setRequest, setResponse, setTagEpilog, setTagProlog, setVisible, toString, write, write, write

Methods inherited from interface com.sas.actionprovider.HttpActionProviderViewInterface

getRequest, setRequest

Constructor Detail

BaseActionTransformation

public BaseActionTransformation()

Default constructor.

Method Detail

getActionProvider

public HttpActionProvider getActionProvider()

Returns the HttpActionProvider object

Specified by:

getActionProvider in interface HttpActionProviderInterface

Returns:

HttpActionProvider object

See Also:

HttpActionProviderInterface.setActionProvider(com.sas.actionprovider.HttpActionProvider)

setActionProvider

public void setActionProvider(HttpActionProvider provider)

Sets the HttpActionProvider object

Specified by:

setActionProvider in interface HttpActionProviderInterface

Parameters:

HttpActionProvider - object

See Also:

HttpActionProviderInterface.getActionProvider()

getUniqueId

public java.lang.Object getUniqueId()

Returns the Viewer's uniqueId

Specified by:

getUniqueId in interface ActionProviderViewInterface

Returns:

the Viewer's uniqueId

See Also:

ActionProviderViewInterface.setUniqueId(java.lang.Object)

setUniqueId

public void setUniqueId(java.lang.Object uniqueId)

Sets the Viewer's uniqueId

Specified by:

setUniqueId in interface ActionProviderViewInterface

Parameters:

uniqueId - the Viewer's uniqueId

See Also:

ActionProviderViewInterface.getUniqueId()

setActionVisible

public void setActionVisible(java.lang.String actionType,
                             java.lang.String areaType,
                             boolean visible)

Sets the visible status of the specified actionType for the specified area. The actionType must be non-null. The actionType and areaType must be valid in the support class that is associated with this classes current actionSupportType attribute.

Specified by:

setActionVisible in interface ActionProviderViewInterface

Parameters:

actionType - The key that identifies the type of action.

area - The area affected by the change in visibility fort the actionType. If null, then the method call applies to all the known areaTypes.

visible - The boolean indicating whether the actionType should be hidden or unhidden.

Throws:

java.lang.IllegalArgumentException - if non-null Area specified with a null areaType attribute.

java.lang.IllegalStateException - if actionSupportType not set.

See Also:

ActionProviderViewInterface.isActionVisible(java.lang.String, java.lang.String), ActionProviderSupportTypes

isActionVisible

public boolean isActionVisible(java.lang.String actionType,
                               java.lang.String areaType)

Returns a boolean indicating if the action type is visible everywhere in the specified areaType. If the actionType is not visible anywhere anywhere in the areaType, then false is returned.

Specified by:

isActionVisible in interface ActionProviderViewInterface

Parameters:

actionType - The key that identifies the type of action as defined by the support class.

areaType - The key that identifies the type of area as defined by the support class.

Returns:

a boolean indicating if the action type is visible everywhere in the specified areaType.

See Also:

ActionProviderViewInterface.setActionVisible(java.lang.String, java.lang.String, boolean), ActionProviderSupportTypes

listAreaTypes

public java.util.Collection listAreaTypes()

Returns a Collection of String keys that define the valid areaTypes for the action support class designated by the actionSupportType attribute.

Specified by:

listAreaTypes in interface ActionProviderViewInterface

Returns:

a Collection of String keys that define the valid areaTypes for the specified support class.

See Also:

ActionProviderViewInterface.listActionTypes(java.lang.String), ActionProviderViewInterface.setActionSupportType(java.lang.String)

listActionTypes

public java.util.Collection listActionTypes(java.lang.String areaType)

Returns a Collection of String keys that define the valid actionTypes for the specified area of the action support class designated the actionSupportType attribute.

Specified by:

listActionTypes in interface ActionProviderViewInterface

Parameters:

areaType - The key associated with a defined areaType.

Returns:

a Collection of String keys that define the valid actionTypes for the specified area of the specified support class.

See Also:

ActionProviderViewInterface.listAreaTypes(), ActionProviderViewInterface.setActionSupportType(java.lang.String)

setActionSupportType

public void setActionSupportType(java.lang.String actionSupportType)

Set the key that associated with a particular support class in the ActionProvider framework.

Specified by:

setActionSupportType in interface ActionProviderViewInterface

Parameters:

actionSupportType - The key that is associated with a particular support class.

See Also:

ActionProviderViewInterface.getActionSupportType(), ActionProviderSupportTypes

getActionSupportType

public java.lang.String getActionSupportType()

Return the key that associated with a particular support class in the ActionProvider framework.

Specified by:

getActionSupportType in interface ActionProviderViewInterface

Returns:

the key that associated with a particular support class.

See Also:

ActionProviderViewInterface.setActionSupportType(java.lang.String), ActionProviderSupportTypes

write

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

Writes the custom attributes of the object. All transformation beans should override this method and call SUPER.

Specified by:

write in interface TransformationInterface

Specified by:

write in interface com.sas.util.WriteToPrintWriterInterface

Overrides:

write in class BaseTransformation

Parameters:

out - The output stream

Throws:

java.io.IOException - Thrown if some type of I/O error occurs

dispose

public void dispose()

This method exists for consumers to call when they are done with a component to ensure that the HttpActionProvider is cleared of all references to and for the component.

Calling any methods on a component after it has been disposed is not recommended and can have undesirable results.

See Also:

HttpActionProvider