com.sas.actionprovider.support
Class SwingViewerSupport

com.sas.actionprovider.support.SwingViewerSupport

All Implemented Interfaces:

ActionProviderViewInterface, SwingActionProviderViewInterface

@SASScope(value="ALL")
public class SwingViewerSupport
implements SwingActionProviderViewInterface

Provides a common implementation of the SwingActionProviderViewInterface to which components may delegate their own implementations of that interface.

Swing components that acquire their Actions via the ActionProvider Framework (APF) are required to implement that interface.

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 Samples Site.

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:

SwingActionProviderViewInterface

Constructor Summary

SwingViewerSupport(ActionProviderViewInterface viewer)
Constructor that takes an instance of the view component that this class supports.

Method Summary

SwingActionProvider	getActionProvider() Returns the SwingActionProvider object from which this component will acquire its Actions.
java.util.Collection	listActionTypes(java.lang.String areaType) Returns a Collection of String keys that define the valid actionTypes as defined by the support class that is currently associated with this component.
java.util.Collection	listAreaTypes() Returns a Collection of String keys that define the valid areaTypes as defined by the support class that is currently associated with this component.
void	setActionProvider(SwingActionProvider actionProvider) Sets the SwingActionProvider object from which this component will acquire its Actions.

Methods inherited from class com.sas.actionprovider.support.BaseViewerSupport

getActionSupportType, getUniqueId, isActionVisible, setActionSupportType, setActionVisible, setUniqueId

Methods inherited from interface com.sas.actionprovider.ActionProviderViewInterface

getActionSupportType, getUniqueId, isActionVisible, setActionSupportType, setActionVisible, setUniqueId

Constructor Detail

SwingViewerSupport

public SwingViewerSupport(ActionProviderViewInterface viewer)

Constructor that takes an instance of the view component that this class supports.

Parameters:

viewer - The instance of the view component.

Method Detail

getActionProvider

public SwingActionProvider getActionProvider()

Returns the SwingActionProvider object from which this component will acquire its Actions.

Specified by:

getActionProvider in interface SwingActionProviderViewInterface

Returns:

ActionProvider object

See Also:

setActionProvider(com.sas.actionprovider.SwingActionProvider)

setActionProvider

public void setActionProvider(SwingActionProvider actionProvider)

Sets the SwingActionProvider object from which this component will acquire its Actions.

Specified by:

setActionProvider in interface SwingActionProviderViewInterface

Parameters:

The - ActionProvider object

See Also:

getActionProvider()

listAreaTypes

public java.util.Collection listAreaTypes()

Returns a Collection of String keys that define the valid areaTypes as defined by the support class that is currently associated with this component.

Specified by:

listAreaTypes in interface ActionProviderViewInterface

Specified by:

listAreaTypes in class BaseViewerSupport

Returns:

a Collection of String keys that define the valid areaTypes.

Throws:

java.lang.IllegalStateException - if actionSupportType not set.

See Also:

listActionTypes(java.lang.String), BaseViewerSupport.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 as defined by the support class that is currently associated with this component.

Specified by:

listActionTypes in interface ActionProviderViewInterface

Specified by:

listActionTypes in class BaseViewerSupport

Parameters:

areaType - The key associated with a defined areaType.

Returns:

a Collection of String keys that define the valid actionTypes.

Throws:

java.lang.IllegalStateException - if actionSupportType not set.

java.lang.IllegalArgumentException - if areaType is null.

See Also:

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