com.sas.swing.visuals.olaptableview
Class OLAPDrillState

com.sas.swing.visuals.olaptableview.OLAPDrillState

All Implemented Interfaces:

ActionProviderViewInterface, SwingActionProviderViewInterface, com.sas.collection.ContentsChangedListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener

public class OLAPDrillState
implements SwingActionProviderViewInterface, com.sas.collection.ContentsChangedListener

See Also:

Serialized Form

Field Summary

static java.lang.String

RB_KEY Key used to lookup resources in the resource bundle.

Constructor Summary

OLAPDrillState()
Constructs a default OLAPDrillState.

Method Summary

void	contentsChanged(com.sas.collection.ContentsChangedEvent event) Invoked when the OLAPDrillState receives a ContentsChangeEvent from the action provider.
protected void	createLayout()
SwingActionProvider	getActionProvider() Returns the ActionProvider object
java.lang.String	getActionSupportType() Return the key that associated with a particular support class in the ActionProvider framework.
java.awt.Color	getColor() Returns the color for the OLAPDrillState drill state items text.
protected void	getDrillStateActions() Invoked when the OLAPDrillState receives a ContentsChangeEvent from the action provider, or when the action provider or model is set.
static com.sas.beans.ExtendedBeanInfo	getExtendedBeanInfo() Returns information used by the com.sas.beans.Introspector to augment the automatically introspected information about this OLAPDrillState.
java.awt.Font	getFont() Returns the font for the drill state items text.
java.awt.Color	getLabelColor() Returns the color for the OLAPDrillState drill state label.
java.awt.Font	getLabelFont() Returns the font for the OLAPDrillState drill state label.
int	getLabelType() Returns the type of label to display at the beginning of the drill state items.
OLAPDataSetInterface	getModel() Return the model for the OLAPDtillState.
java.lang.String	getSeparator() Returns the separator used in between the drilled member labels of the OLAPDrillState.
java.awt.Color	getSeparatorColor() Returns the color of the text used as the separator between the drilled member labels of the OLAPDrillState.
java.awt.Font	getSeparatorFont() Returns the font of the text used as the separator between the drilled member labels of the OLAPDrillState.
java.lang.String	getSeparatorImage() Returns the separator image used in between the drilled member labels of the OLAPDrillState.
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.
protected void	refreshDrillStateView() Updates the OLAPDrillState component.
void	setActionProvider(SwingActionProvider actionProvider) Sets the ActionProvider 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	setColor(java.awt.Color color) Sets the color for the OLAPDrillState drill state items text.
void	setFont(java.awt.Font font) Sets the font for the drill state items text.
void	setLabelColor(java.awt.Color labelColor) Sets the color for the OLAPDrillState drill state label.
void	setLabelFont(java.awt.Font labelFont) Sets the font for the OLAPDrillState drill state label.
void	setLabelType(int labelType) Sets the type of label to display at the beginning of the drill state items.
void	setModel(OLAPDataSetInterface model) Sets the model for the OLAPDrillState.
void	setSeparator(java.lang.String value) Sets the separator string used in between the drilled member labels of the OLAPDrillState.
void	setSeparatorColor(java.awt.Color separatorColor) Sets the color of the text used as the separator between the drilled member labels of the OLAPDrillState.
void	setSeparatorFont(java.awt.Font separatorFont) Sets the font of the text used as the separator between the drilled member labels of the OLAPDrillState.
void	setSeparatorImage(java.lang.String value) Sets the filename or the path of the separator image used between the drilled member labels of the OLAPDrillState.
void	setUniqueId(java.lang.Object uniqueId) Returns the Viewer's uniqueId

Field Detail

RB_KEY

public static final java.lang.String RB_KEY

Key used to lookup resources in the resource bundle.

See Also:

Constant Field Values

Constructor Detail

OLAPDrillState

public OLAPDrillState()

Constructs a default OLAPDrillState.

Method Detail

getExtendedBeanInfo

public static com.sas.beans.ExtendedBeanInfo getExtendedBeanInfo()

Returns information used by the com.sas.beans.Introspector to augment the automatically introspected information about this OLAPDrillState.

Returns:

the ExtendedBeanInfo for this class

createLayout

protected void createLayout()

getModel

public OLAPDataSetInterface getModel()

Return the model for the OLAPDtillState. Returns null if not set.

Returns:

the model for the OLAPDrillState component

setModel

public void setModel(OLAPDataSetInterface model)

Sets the model for the OLAPDrillState.

Parameters:

model - the model for the OLAPDrillState component

setLabelType

public void setLabelType(int labelType)

Sets the type of label to display at the beginning of the drill state items. Valid values are com.sas.swing.visuals.olaptableview.OLAPDrillStateUtil.DIMENSION, com.sas.swing.visuals.olaptableview.OLAPDrillStateUtil.HIERARCHY, or com.sas.swing.visuals.olaptableview.OLAPDrillStateUtil.NONE. The default behavior is to have no label.

Parameters:

labelType - the type of display label to use for the drill state items

getLabelType

public int getLabelType()

Returns the type of label to display at the beginning of the drill state items.

contentsChanged

public void contentsChanged(com.sas.collection.ContentsChangedEvent event)

Invoked when the OLAPDrillState receives a ContentsChangeEvent from the action provider.

Application code will not use this method explicitly, it is used internally by OLAPDrillState.

Specified by:

contentsChanged in interface com.sas.collection.ContentsChangedListener

Parameters:

event - the contents changed event

getDrillStateActions

protected void getDrillStateActions()

Invoked when the OLAPDrillState receives a ContentsChangeEvent from the action provider, or when the action provider or model is set. This method uses the action provider to query the model for information about its drilled dimensions.

Application code will not use this method explicitly, it is used internally by OLAPDrillState.

refreshDrillStateView

protected void refreshDrillStateView()

Updates the OLAPDrillState component. This method is called internally whenever a change occurs in the OLAPDrillState requiring it to refresh.

setFont

public void setFont(java.awt.Font font)

Sets the font for the drill state items text.

Overrides:

setFont in class javax.swing.JComponent

See Also:

getFont()

getFont

public java.awt.Font getFont()

Returns the font for the drill state items text.

Specified by:

getFont in interface java.awt.MenuContainer

Overrides:

getFont in class java.awt.Component

See Also:

setFont(java.awt.Font)

setLabelFont

public void setLabelFont(java.awt.Font labelFont)

Sets the font for the OLAPDrillState drill state label.

See Also:

getLabelFont()

getLabelFont

public java.awt.Font getLabelFont()

Returns the font for the OLAPDrillState drill state label.

See Also:

setLabelFont(java.awt.Font)

setColor

public void setColor(java.awt.Color color)

Sets the color for the OLAPDrillState drill state items text. The default color is SystemColor.activeCaption.

See Also:

getColor()

getColor

public java.awt.Color getColor()

Returns the color for the OLAPDrillState drill state items text. The default color is SystemColor.activeCaption.

See Also:

setColor(java.awt.Color)

setLabelColor

public void setLabelColor(java.awt.Color labelColor)

Sets the color for the OLAPDrillState drill state label. The default color is SystemColor.controlText.

See Also:

getLabelColor()

getLabelColor

public java.awt.Color getLabelColor()

Returns the color for the OLAPDrillState drill state label. The default label color is SystemColor.controlText.

See Also:

setLabelColor(java.awt.Color)

setSeparator

public void setSeparator(java.lang.String value)

Sets the separator string used in between the drilled member labels of the OLAPDrillState. The default separator is ">". This value is ignored if a separator image has been set.

Parameters:

value - The separator of the OLAPDrillState

getSeparator

public java.lang.String getSeparator()

Returns the separator used in between the drilled member labels of the OLAPDrillState. The default separator is ">".

setSeparatorImage

public void setSeparatorImage(java.lang.String value)

Sets the filename or the path of the separator image used between the drilled member labels of the OLAPDrillState. The specified String can be a file name or a file path. When specifying a path, use the Internet-standard forward-slash ("/") as a separator.

Parameters:

value - The separator filename of path of the image of the OLAPDrillState

See Also:

getSeparatorImage()

getSeparatorImage

public java.lang.String getSeparatorImage()

Returns the separator image used in between the drilled member labels of the OLAPDrillState.

See Also:

setSeparatorImage(java.lang.String)

setSeparatorColor

public void setSeparatorColor(java.awt.Color separatorColor)

Sets the color of the text used as the separator between the drilled member labels of the OLAPDrillState. The default separator color is SystemColor.activeCaption. This value is ignored if a separator image has been set.

See Also:

getSeparatorColor()

getSeparatorColor

public java.awt.Color getSeparatorColor()

Returns the color of the text used as the separator between the drilled member labels of the OLAPDrillState. This value is ignored if a separator image has been set. The default color is SystemColor.activeCaption.

See Also:

setSeparatorColor(java.awt.Color)

setSeparatorFont

public void setSeparatorFont(java.awt.Font separatorFont)

Sets the font of the text used as the separator between the drilled member labels of the OLAPDrillState. This value is ignored if a separator image has been set.

See Also:

getSeparatorFont()

getSeparatorFont

public java.awt.Font getSeparatorFont()

Returns the font of the text used as the separator between the drilled member labels of the OLAPDrillState. This value is ignored if a separator image has been set.

See Also:

setSeparatorFont(java.awt.Font)

setActionProvider

public void setActionProvider(SwingActionProvider actionProvider)

Sets the ActionProvider object

Specified by:

setActionProvider in interface SwingActionProviderViewInterface

Parameters:

ActionProvider - object

See Also:

SwingActionProviderViewInterface.getActionProvider()

getActionProvider

public SwingActionProvider getActionProvider()

Returns the ActionProvider object

Specified by:

getActionProvider in interface SwingActionProviderViewInterface

Returns:

ActionProvider object

See Also:

SwingActionProviderViewInterface.setActionProvider(com.sas.actionprovider.SwingActionProvider)

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 null or invalid actionType specified.

java.lang.IllegalArgumentException - if invalid areaType specified.

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

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)

Returns the Viewer's uniqueId

Specified by:

setUniqueId in interface ActionProviderViewInterface

See Also:

ActionProviderViewInterface.getUniqueId()

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

Parameters:

actionSupportType - The key associated with a support class.

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:

actionSupportType - The key associated with a support class.

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