com.sas.actionprovider
Interface ActionProviderViewInterface

All Known Subinterfaces:

HttpActionProviderViewInterface, SwingActionProviderViewInterface

All Known Implementing Classes:

AbstractBaseTableView, ActionProviderMenuBar, BarChart, BarChartComposite, BarLineChart, BarLineChartComposite, BaseActionCompositeTransformation, com.sas.servlet.tbeans.BaseActionCompositeTransformation2, BaseActionTransformation, com.sas.servlet.tbeans.BaseActionTransformation2, com.sas.servlet.tbeans.graphics.BaseBarChart, BaseBarLineChart, BaseESRIMapChart, com.sas.servlet.tbeans.graphics.BaseGraph, com.sas.servlet.tbeans.graphics.BaseGraphics, BaseLabel, BaseLineChart, BaseLinePlot, BaseNavigationBarElement, BaseOLAPDrillState, BaseOLAPTableView, BasePieChart, BaseRadarChart, BaseRemoteFileSearch, BaseRemoteFileSelector, BaseRemoteFileSelectorPanel, BaseRemoteFileToolBar, BaseScatterPlot, BaseTableView, BaseTileChart, BaseWaterfallChart, CellContentsLabelRenderer, CellContentsNoRowsRenderer, DefaultOLAPTableDataCellContentsRenderer, DefaultOLAPTableLabelCellContentsRenderer, ESRIMapChart, ESRIMapComposite, ESRIMapMenu, GraphComposite, HttpViewerSupport, IFileServiceSelectorPanel, InformationServicesSearch, InformationServicesSearchPanel, InformationServicesSelector, InformationServicesSelectorPanel, Label, LineChart, LineChartComposite, LinePlot, LinePlotComposite, NavigationBarColumnScrollingElement, NavigationBarEditingElement, NavigationBarRowScrollingElement, NavigationBarScrollingElement, OLAPDrillState, OLAPDrillState, OLAPESRIMapChart, OLAPESRIMapComposite, OLAPESRIMapMenu, com.sas.servlet.tbeans.olapgraphics.html.OLAPGraphComposite, OLAPMenuBar, OLAPTableView, OLAPTableView, PieChart, PieChartComposite, RadarChart, RadarChartComposite, RelationalMenuBar, RemoteFileSearch, RemoteFileSearchComponent, RemoteFileSearchPanel, RemoteFileSelector, RemoteFileToolBar, ScatterPlot, ScatterPlotComposite, ShowDetailDataComposite, SwingViewerSupport, TableView, TableView, TableView, TableView, TextAction, TileChart, WaterfallChart, WaterfallChartComposite

public interface ActionProviderViewInterface

The base interface for viewer components that acquire their Actions via the ActionProvider Framework (APF).

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

Method Summary

java.lang.String	getActionSupportType() Return the key that is mapped to a particular support class in the APF.
java.lang.Object	getUniqueId() Returns the unique identifier used by the APF to distinguish between multiple components.
boolean	isActionVisible(java.lang.String actionType, java.lang.String areaType) Returns a boolean indicating if the action type is visible in the specified area.
java.util.Collection	listActionTypes(java.lang.String areaType) Returns a Collection of String objects that are keys representing valid actionTypes as defined by the support class that is currently associated with this component.
java.util.Collection	listAreaTypes() Returns a Collection of String objects that are keys representing the valid areaTypes as defined by the support class that is currently associated with this component.
void	setActionSupportType(java.lang.String actionSupportType) Sets the key that is mapped to a particular support class in the APF.
void	setActionVisible(java.lang.String actionType, java.lang.String areaType, boolean visible) Sets the visibility status of the specified actionType for the specified area.
void	setUniqueId(java.lang.Object uniqueId) Sets the unique identifier used by the APF to distinguish between multiple components.

Method Detail

setActionVisible

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

Sets the visibility status of the specified actionType for the specified area.

The actionType and areaType keys are defined by the support class to which the viewer will query for Actions, indirectly, throught its ActionProvider.

Parameters:

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

areaType - The key that identifies the general area to which the actionType is registered.

If null, then the method call applies to all the known areaTypes.

visible - The boolean indicating whether the actionType should be visible.

See Also:

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

isActionVisible

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

Returns a boolean indicating if the action type is visible in the specified area.

The actionType and areaType keys are defined by the support class to which the viewer indirectly queries for Actions through its ActionProvider.

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. If null, the method returns true only if the action is visible in all areaTypes defined by the support class.

Returns:

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

See Also:

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

listAreaTypes

java.util.Collection listAreaTypes()

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

Returns:

a Collection of String keys that define the valid areaTypes.

See Also:

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

listActionTypes

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

Returns a Collection of String objects that are keys representing valid actionTypes as defined by the support class that is currently associated with this component.

Parameters:

areaType - The key associated with a defined areaType.

Returns:

a Collection of String keys that define the valid actionTypes.

See Also:

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

setActionSupportType

void setActionSupportType(java.lang.String actionSupportType)

Sets the key that is mapped to a particular support class in the APF.

Parameters:

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

See Also:

getActionSupportType(), ActionProviderSupportTypes

getActionSupportType

java.lang.String getActionSupportType()

Return the key that is mapped to a particular support class in the APF.

Returns:

the key that associated with a particular support class.

See Also:

setActionSupportType(java.lang.String), ActionProviderSupportTypes

getUniqueId

java.lang.Object getUniqueId()

Returns the unique identifier used by the APF to distinguish between multiple components.

Returns:

the Viewer's uniqueId

See Also:

setUniqueId(java.lang.Object)

setUniqueId

void setUniqueId(java.lang.Object uniqueId)

Sets the unique identifier used by the APF to distinguish between multiple components.

Parameters:

the - Viewer's uniqueId

See Also:

getUniqueId()