Package org.apache.log4j.chainsaw.help
Class HelpManager
java.lang.Object
org.apache.log4j.chainsaw.help.HelpManager
Singleton help manager where objects can register to display
Help for something, an independant viewer can register to
be notified when the requested Help URL changes and can display
it appropriately. This class effectively decouples the help requester
from the help implementation (if any!)
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate HelpLocator
private URL
private static final HelpManager
private final org.apache.log4j.Logger
private final PropertyChangeSupport
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
addPropertyChangeListener
(String propertyName, PropertyChangeListener listener) void
void
firePropertyChange
(String propertyName, boolean oldValue, boolean newValue) void
firePropertyChange
(String propertyName, int oldValue, int newValue) void
firePropertyChange
(String propertyName, Object oldValue, Object newValue) Determines the most appropriate Help resource for a particular class or returns ChainsawConstants.URL_PAGE_NOT_FOUND if there is no resource located.static HelpManager
void
void
removePropertyChangeListener
(String propertyName, PropertyChangeListener listener) void
setHelpURL
(URL helpURL) The current Help URL that should be displayed, and is a PropertyChangeListener supported property.void
Given a class, and that it belongs within the org.apache.log4j project, sets the URL to the JavaDoc for that class.
-
Field Details
-
instance
-
helpLocator
-
helpURL
-
propertySupport
-
logger
private final org.apache.log4j.Logger logger
-
-
Constructor Details
-
HelpManager
private HelpManager()
-
-
Method Details
-
setHelpURL
The current Help URL that should be displayed, and is a PropertyChangeListener supported property.This method ALWAYS fires property change events even if the value is the same (the oldvalue of the event will be null)
- Parameters:
helpURL
-
-
addPropertyChangeListener
- Parameters:
listener
-
-
addPropertyChangeListener
- Parameters:
propertyName
-listener
-
-
firePropertyChange
- Parameters:
evt
-
-
firePropertyChange
- Parameters:
propertyName
-oldValue
-newValue
-
-
firePropertyChange
- Parameters:
propertyName
-oldValue
-newValue
-
-
firePropertyChange
- Parameters:
propertyName
-oldValue
-newValue
-
-
removePropertyChangeListener
- Parameters:
listener
-
-
removePropertyChangeListener
- Parameters:
propertyName
-listener
-
-
getInstance
-
showHelpForClass
Given a class, and that it belongs within the org.apache.log4j project, sets the URL to the JavaDoc for that class.- Parameters:
c
-
-
getHelpForClass
Determines the most appropriate Help resource for a particular class or returns ChainsawConstants.URL_PAGE_NOT_FOUND if there is no resource located.- Returns:
- URL
-