com.limegroup.gnutella.gui.statistics.panes
Class AbstractOptionPaneItem

java.lang.Object
  extended bycom.limegroup.gnutella.gui.statistics.panes.AbstractOptionPaneItem
All Implemented Interfaces:
PaneItem, RefreshListener
Direct Known Subclasses:
AdvancedStats, BandwidthStats, NetStats

public abstract class AbstractOptionPaneItem
extends java.lang.Object
implements PaneItem

This class provides a skeletal implementation of the PaneItem interface.

It provides the basic implementation for displaying one statistic within a larger window of statistics. Each AbstractPaneItem has a titled border and a label describing the statistic. The label is followed by standardized spacing.

It includes several convenience methods that subclasses may us to simplify panel construction.

Subclasses only need to override the applyStatistics() method for storing statistics to disk.


Constructor Summary
protected AbstractOptionPaneItem(java.lang.String key)
          This sole constructor overrides the the public accessibility of the default constructor and is usually called implicitly.
 
Method Summary
protected  void add(java.awt.Component comp)
          Adds the specified Component to the enclosed Container instance.
 void componentResized(java.awt.event.ComponentEvent e, java.awt.Component comp)
          Notifies the StatisticsPane that the component has been resized.
 java.awt.Container getContainer()
          Returns the Container for this set of statistics.
protected  java.awt.Component getHorizontalSeparator()
          Returns a Component standardly sized for horizontal separators.
 javax.swing.JComponent getStatsComponent()
          Accessor for the component that displays the statistic -- without the label or associated components.
protected  java.awt.Component getVerticalSeparator()
          Returns a Component standardly sized for vertical separators.
 void refresh()
          Called when a UI refresh event has occurred.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractOptionPaneItem

protected AbstractOptionPaneItem(java.lang.String key)
This sole constructor overrides the the public accessibility of the default constructor and is usually called implicitly.

Parameters:
key - the key for obtaining the locale-specific values for displayed strings
Method Detail

getStatsComponent

public javax.swing.JComponent getStatsComponent()
Description copied from interface: PaneItem
Accessor for the component that displays the statistic -- without the label or associated components.

Specified by:
getStatsComponent in interface PaneItem
Returns:
the JComponent instance that contains the stat display

getContainer

public java.awt.Container getContainer()
Description copied from interface: PaneItem
Returns the Container for this set of statistics.

Specified by:
getContainer in interface PaneItem
Returns:
the Container for this set of statistics

add

protected final void add(java.awt.Component comp)
Adds the specified Component to the enclosed Container instance.

Parameters:
comp - the Component to add

getHorizontalSeparator

protected final java.awt.Component getHorizontalSeparator()
Returns a Component standardly sized for horizontal separators.

Returns:
the constant Component used as a standard horizontal separator

getVerticalSeparator

protected final java.awt.Component getVerticalSeparator()
Returns a Component standardly sized for vertical separators.

Returns:
the constant Component used as a standard vertical separator

refresh

public void refresh()
Description copied from interface: RefreshListener
Called when a UI refresh event has occurred. Refresh any elements of this component that need refreshing.

Specified by:
refresh in interface RefreshListener

componentResized

public void componentResized(java.awt.event.ComponentEvent e,
                             java.awt.Component comp)
Description copied from interface: PaneItem
Notifies the StatisticsPane that the component has been resized.

Specified by:
componentResized in interface PaneItem
Parameters:
e - the ComponentEvent that generated the resize
comp - the pane Component