com.sas.actionprovider
Class Area

java.lang.Object
  |
  +--com.sas.actionprovider.Area

public class Area

extends java.lang.Object

The Area object is used by the ActionProvider Framework( APF ) as a mechanism for describing a particular area of a Viewer component in a more specific way than the general areaType that is defined by a support class.

For example, the HttpTableViewSupport.COLUMN_HEADER_AREA is a general areaType defined by HttpTableViewSupport to identify all the column headers of a TableView. To specify that an operation should only affect certain colum(s) within the COLUMN_HEADER_AREA, the Area Object allows for the setting of specific values.

Area area = new Area( HttpTableViewSupport.COLUMN_HEADER_AREA, "someColumnName" );

The types of values that are required is defined by the APF support class.

A basic understanding of the ActionProvider Framework, of which this class is a part, is recommended before attempting to use this class.

• For general information on the ActionProvider Framework, including an overview of how the primary classes of the framework work together, refer to the com.sas.actionprovider package documentation.

• For examples demonstrating how to use the ActionProvider Framework, including how to override default Actions or add new custom Actions, refer to the ActionProvider Framework Examples Site. You will initially see a subset of examples relating to this framework. You can search for other types of examples as needed.

Visit the AppDev Studio Developer's Site to access step-by-step examples, white papers and additional usage information at http://support.sas.com/rnd/appdev/.

Note: A snapshot of the AppDev Studio Developers Site is installed on your local Web server when you install AppDev Studio. To access the site from webAF, select Help -> Developer Site .

Since:

3.0

See Also:

HttpTableViewSupport, BaseActionProviderSupport.setAction(com.sas.actionprovider.BaseAction, java.util.Collection, com.sas.actionprovider.Area)

Field Summary

protected String	type The general type of area corresponding to an areaType defined by a support class.
protected List	values The collection of specific area values that this Area describes.

Constructor Summary

Area()
Default constructor

Area(String type)
AreaType constructor

Area(String type, Object value)
AreaType, Value constructor.

Method Summary

void	addValue(Object value) Add a specific area value.
String	getType() Return the general type of area corresponding to an areaType defined by a support class.
List	getValues() Returns the collection of specific area values.
void	removeValue(Object value) Removes a specific area value from this Area definition.
void	setType(String type) Set the type of area corresponding to an areaType defined by a support class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

type

protected String type

The general type of area corresponding to an areaType defined by a support class.

values

protected List values

The collection of specific area values that this Area describes.

Constructor Detail

Area

public Area()

Default constructor

Area

public Area(String type)

AreaType constructor

Parameters:

type - The general type of area corresponding to an areaType defined by a support class.

Area

public Area(String type,
            Object value)

AreaType, Value constructor.

Parameters:

type - The general type of area corresponding to an areaType defined by a support class.

value - A specific area value

Method Detail

setType

public void setType(String type)

Set the type of area corresponding to an areaType defined by a support class.

Parameters:

type - The general type of area corresponding to an areaType defined by a support class.

See Also:

getType()

getType

public String getType()

Return the general type of area corresponding to an areaType defined by a support class.

Returns:

the general type of area corresponding to an areaType defined by a support class.

See Also:

setType(java.lang.String)

addValue

public void addValue(Object value)

Add a specific area value.

Parameters:

value - the specific area value.

Throws:

IllegalArgumentException - if value is null

See Also:

removeValue(java.lang.Object)

removeValue

public void removeValue(Object value)

Removes a specific area value from this Area definition.

Parameters:

value - the specific area value to be removed.

Throws:

IllegalArgumentException - if value is null

See Also:

addValue(java.lang.Object)

getValues

public List getValues()

Returns the collection of specific area values.

Returns:

the collection of specific area values.