eTextReader.actions
Class AuthorListingAction

java.lang.Object
  javax.swing.AbstractAction
      eTextReader.actions.BaseAction
          eTextReader.actions.NotationListingAction
              eTextReader.actions.AuthorListingAction

All Implemented Interfaces:

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

public class AuthorListingAction
extends NotationListingAction

This class provides an implementation of the NotationListingAction action that lists all annotations authored by a given user. The author is initially set to the current user; this can be changed by calling the setAuthor(String) method

Author:

mcfall

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class eTextReader.actions.BaseAction

BaseAction.Key

Field Summary

private FieldFilter

filter

Fields inherited from class eTextReader.actions.NotationListingAction

container, provider

Fields inherited from class eTextReader.actions.BaseAction

instances

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

AuthorListingAction(ContentContainer container)

AuthorListingAction(ContentContainer container, java.lang.String fileName)
Constructs an AuthorListingAction associated with the specified container and with the given icon.

Method Summary

protected java.lang.String	getName() Returns the name associated with this action, displayed in menus, buttons, etc.
protected NotationFilter	getNotationFilter() Returns the NotationFilter used to filter the set of annotations that are displayed by the NotationListing interface.
protected java.lang.String	getTooltipText() Returns the tooltip text associated with this action
void	setAuthor(java.lang.String author) Associates this action with the specified author

Methods inherited from class eTextReader.actions.NotationListingAction

actionPerformed, configureFilter, configureProvider, getNotationProvider

Methods inherited from class eTextReader.actions.BaseAction

getAcceleratorKeyStrokeFromPreferences, getInstance, propertyChange

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

Field Detail

filter

private FieldFilter filter

Constructor Detail

AuthorListingAction

public AuthorListingAction(ContentContainer container)

Parameters:

container -

AuthorListingAction

public AuthorListingAction(ContentContainer container,
                           java.lang.String fileName)

Constructs an AuthorListingAction associated with the specified container and with the given icon. The author is initially set to be the current user.

Parameters:

container -

fileName -

Method Detail

getNotationFilter

protected NotationFilter getNotationFilter()

Description copied from class: NotationListingAction

Returns the NotationFilter used to filter the set of annotations that are displayed by the NotationListing interface. The default implementation returns an instance of IncludeAllFilter

Overrides:

getNotationFilter in class NotationListingAction

Returns:

the NotationFilter associated with this action

setAuthor

public void setAuthor(java.lang.String author)

Associates this action with the specified author

Parameters:

author - the author whose annotations this action should list

getName

protected java.lang.String getName()

Description copied from class: NotationListingAction

Returns the name associated with this action, displayed in menus, buttons, etc.

Specified by:

getName in class NotationListingAction

Returns:

the String used to represent this action

getTooltipText

protected java.lang.String getTooltipText()

Description copied from class: NotationListingAction

Returns the tooltip text associated with this action

Specified by:

getTooltipText in class NotationListingAction

Returns:

the String used as the tooltip text