eTextReader.actions
Class AnnotationTypeAction

java.lang.Object
  extended by javax.swing.AbstractAction
      extended by eTextReader.actions.BaseAction
          extended by eTextReader.actions.NotationListingAction
              extended by eTextReader.actions.AnnotationTypeAction
All Implemented Interfaces:
java.awt.event.ActionListener, java.beans.PropertyChangeListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action

public class AnnotationTypeAction
extends NotationListingAction

This class displays all of the annotations of a given type. The page scope is all pages.

Author:
mcfall
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class eTextReader.actions.BaseAction
BaseAction.Key
 
Field Summary
private  AnnotationTypeFilter 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
AnnotationTypeAction(ContentContainer container)
           
AnnotationTypeAction(ContentContainer container, java.lang.String fileName)
           
 
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
protected  void setType(Notation.AnnotationType type)
           
 
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 AnnotationTypeFilter filter
Constructor Detail

AnnotationTypeAction

public AnnotationTypeAction(ContentContainer container)
Parameters:
container -

AnnotationTypeAction

public AnnotationTypeAction(ContentContainer container,
                            java.lang.String fileName)
Parameters:
container -
fileName -
Method Detail

setType

protected void setType(Notation.AnnotationType type)

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

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