ca.sqlpower.architect.swingui.action
Class AbstractArchitectAction

java.lang.Object
  javax.swing.AbstractAction
      ca.sqlpower.architect.swingui.action.AbstractArchitectAction

All Implemented Interfaces:

java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action

Direct Known Subclasses:

AboutAction, AbstractTableTargetedAction, AlignTableAction, AutoLayoutAction, CheckForUpdateAction, CloseProjectAction, CompareDMAction, CreateCubeAction, CreateDimensionAction, CreateEnergonCubeAction, CreateOLAPChildAction, CreateRelationshipAction, CreateTableAction, CreateUsageAction, CreateVirtualCubeAction, DatabaseConnectionManagerAction, DeleteSelectedAction, EditColumnAction, EditCubeAction, EditDimensionAction, EditHierarchyAction, EditIndexAction, EditLevelAction, EditMeasureAction, EditRelationshipAction, EditSchemaAction, EditSelectedAction, EditTableAction, EditVirtualCubeAction, ExportDDLAction, FocusToChildOrParentTableAction, HelpAction, ImportSchemaAction, KettleJobAction, OLAPDeleteSelectedAction, OLAPEditAction, OLAPSchemaManagerAction, OpenProjectAction, PreferencesAction, PrintAction, ProfileAction, ProgressAction, ProjectSettingsAction, RedoAction, ReverseRelationshipAction, SearchReplaceAction, SQLRunnerAction, UndoAction, VisualMappingReportAction, ZoomAction, ZoomResetAction, ZoomToFitAction

public abstract class AbstractArchitectAction
extends javax.swing.AbstractAction

A set of basic functionality that all actions in the Architect rely on.

See Also:

Serialized Form

Field Summary

protected ArchitectFrame	frame
protected PlayPen	playpen
protected ArchitectSwingSession	session

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

AbstractArchitectAction(ArchitectSwingSession session, PlayPen playpen, java.lang.String actionName, java.lang.String actionDescription, javax.swing.Icon icon)
Helper constructor that all architect action subclasses that use an icon will call.

AbstractArchitectAction(ArchitectSwingSession session, PlayPen pp, java.lang.String actionName, java.lang.String actionDescription, java.lang.String iconResourceName)
Helper constructor that all architect action subclasses that use an icon will call.

AbstractArchitectAction(ArchitectSwingSession session, java.lang.String actionName, java.lang.String actionDescription)
Helper constructor that all architect action subclasses that do not use an icon will call.

AbstractArchitectAction(ArchitectSwingSession session, java.lang.String actionName, java.lang.String actionDescription, javax.swing.Icon icon)
Helper constructor that all architect action subclasses that use an icon will call.

AbstractArchitectAction(ArchitectSwingSession session, java.lang.String actionName, java.lang.String actionDescription, java.lang.String iconResourceName)
Helper constructor that all architect action subclasses that use an icon will call.

Method Summary

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.event.ActionListener

actionPerformed

Field Detail

frame

protected final ArchitectFrame frame

playpen

protected final PlayPen playpen

session

protected final ArchitectSwingSession session

Constructor Detail

AbstractArchitectAction

public AbstractArchitectAction(ArchitectSwingSession session,
                               PlayPen playpen,
                               java.lang.String actionName,
                               java.lang.String actionDescription,
                               javax.swing.Icon icon)

Helper constructor that all architect action subclasses that use an icon will call. Ensures that the session, its frame, and its frame's playpen are all non-null.

Parameters:

session - The session that this action will operate on. Must not be null.

playpen - The play pen to use. For actions that deal with the relational play pen, this should be the ArchitectSwingSession's play pen. For OLAP actions, this should be the appropriate OLAP play pen.

actionName - The name for this action. This will appear in menu items.

actionDescription - This action's description. Appears in tooltips.

icon - The icon to use. Null means no icon.

AbstractArchitectAction

public AbstractArchitectAction(ArchitectSwingSession session,
                               java.lang.String actionName,
                               java.lang.String actionDescription,
                               java.lang.String iconResourceName)

Helper constructor that all architect action subclasses that use an icon will call. Ensures that the session, its frame, and its frame's playpen are all non-null.

Parameters:

session - The session that this action will operate on. Must not be null.

actionName - The name for this action. This will appear in menu items.

actionDescription - This action's description. Appears in tooltips.

iconResourceName - The resource name of the icon. See SPSUtils#createIcon(String, String, int)) for details.

AbstractArchitectAction

public AbstractArchitectAction(ArchitectSwingSession session,
                               PlayPen pp,
                               java.lang.String actionName,
                               java.lang.String actionDescription,
                               java.lang.String iconResourceName)

Helper constructor that all architect action subclasses that use an icon will call. Ensures that the session, its frame, and its frame's playpen are all non-null.

Parameters:

session - The session that this action will operate on. Must not be null.

pp - The play pen to use. For actions that deal with the relational play pen, this should be the ArchitectSwingSession's play pen. For OLAP actions, this should be the appropriate OLAP play pen.

actionName - The name for this action. This will appear in menu items.

actionDescription - This action's description. Appears in tooltips.

iconResourceName - The resource name of the icon. See SPSUtils#createIcon(String, String, int)) for details.

AbstractArchitectAction

public AbstractArchitectAction(ArchitectSwingSession session,
                               java.lang.String actionName,
                               java.lang.String actionDescription,
                               javax.swing.Icon icon)

Helper constructor that all architect action subclasses that use an icon will call. Ensures that the session, its frame, and its frame's playpen are all non-null.

Parameters:

session - The session that this action will operate on. Must not be null.

actionName - The name for this action. This will appear in menu items.

actionDescription - This action's description. Appears in tooltips.

icon - The icon to use. Null means no icon.

AbstractArchitectAction

public AbstractArchitectAction(ArchitectSwingSession session,
                               java.lang.String actionName,
                               java.lang.String actionDescription)

Helper constructor that all architect action subclasses that do not use an icon will call. Ensures that the session, its frame, and its frame's playpen are all non-null.

Parameters:

session - The session that this action will operate on. Must not be null.

actionName - The name for this action. This will appear in menu items.

actionDescription - This action's description. Appears in tooltips. SPSUtils.createIcon(String, String) for details.