org.jfree.beans
Class AbstractCategoryChart

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by org.jfree.beans.AbstractChart
                  extended by org.jfree.beans.AbstractCategoryChart
All Implemented Interfaces:
java.awt.event.ActionListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, org.jfree.chart.event.ChartChangeListener
Direct Known Subclasses:
JBarChart

public abstract class AbstractCategoryChart
extends AbstractChart

A base class for chart beans that use a CategoryPlot.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class org.jfree.beans.AbstractChart
chart, chartBuffer, chartBufferHeight, chartBufferWidth, info, legend, legendPosition, listeners, scaleX, scaleY, sourceSubtitle, subtitle
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
AbstractCategoryChart()
          Creates a new instance.
 
Method Summary
 void addCategoryItemClickListener(CategoryItemClickListener listener)
          Registers a listener to receive notification of category item clicks.
 void fireCategoryItemClickEvent(CategoryItemClickEvent event)
          Fires a category item click event.
 java.lang.String getCategoryAxisLabel()
          Returns the category axis label.
 java.awt.Font getCategoryAxisLabelFont()
          Returns the font used for the main label on the category axis.
 java.awt.Paint getCategoryAxisLabelPaint()
          Returns the paint used for the main label on the category axis.
 org.jfree.chart.axis.AxisLocation getCategoryAxisLocation()
          Returns the permitted axis locations for the category axis.
 double getCategoryAxisLowerMargin()
          Returns the lower margin for the category axis.
 double getCategoryAxisMargin()
          Returns the margin between categories along the axis.
 double getCategoryAxisUpperMargin()
          Returns the upper margin for the category axis.
 org.jfree.chart.plot.PlotOrientation getOrientation()
          Returns the orientation for the plot.
 java.lang.String getToolTipFormat()
          Returns the format string for the item tool tips.
 java.lang.String getValueAxisLabel()
          Returns the label for the value axis.
 org.jfree.chart.axis.AxisLocation getValueAxisLocation()
          Returns the permitted axis locations for the value axis.
 double getValueAxisLowerMargin()
          Returns the lower margin for the value axis.
 double getValueAxisUpperMargin()
          Returns the upper margin for the value axis.
 boolean isCategoryAxisLineVisible()
          Returns a flag that conrtols whether or not the category axis draws a line running the length of the axis.
 boolean isValueAxisGridlinesVisible()
          Returns true if the value axis gridlines are visible, and false otherwise.
 boolean isValueAxisInverted()
          Returns true if the value axis is inverted, and false otherwise.
 boolean isValueAxisLineVisible()
          Returns the flag that controls whether or not the value axis draws a line running the length of the axis.
 void mouseClicked(java.awt.event.MouseEvent event)
          If the user clicks on the chart, see if that translates into an event that we report...
 void removeCategoryItemClickListener(CategoryItemClickListener listener)
          Unregisters a listener so that it no longer receives notification of category item clicks.
 void setCategoryAxisLabel(java.lang.String label)
          Sets the category axis label and fires a PropertyChangeEvent for the categoryAxisLabel property.
 void setCategoryAxisLabelFont(java.awt.Font font)
          Sets the font used for the main label on the category axis and fires a PropertyChangeEvent for the categoryAxisLabelFont property.
 void setCategoryAxisLabelPaint(java.awt.Paint paint)
          Sets the paint used for the main label on the category axis and fires a PropertyChangeEvent for the categoryAxisLabelPaint property.
 void setCategoryAxisLineVisible(boolean visible)
          Sets the flag that controls whether or not the category axis draws a line running the length of the axis and fires a PropertyChangeEvent for the categoryAxisLineVisible property.
 void setCategoryAxisLocation(org.jfree.chart.axis.AxisLocation location)
          Sets the axis location for the category axis and fires a PropertyChangeEvent for the categoryAxisLocation property.
 void setCategoryAxisLowerMargin(double margin)
          Sets the lower margin for the category axis and fires a PropertyChangeEvent for the categoryAxisLowerMargin property.
 void setCategoryAxisMargin(double margin)
          Sets the total space allocated to the margin between categories along the axis and fires a PropertyChangeEvent for the categoryAxisMargin property.
 void setCategoryAxisUpperMargin(double margin)
          Sets the upper margin for the category axis and fires a PropertyChangeEvent for the categoryAxisUpperMargin property.
 void setOrientation(org.jfree.chart.plot.PlotOrientation orientation)
          Sets the orientation for the plot and fires a PropertyChangeEvent for the orientation property.
 void setToolTipFormat(java.lang.String format)
          Sets the format string for the section tool tips and fires a PropertyChangeEvent for the toolTipFormat property.
 void setValueAxisGridlinesVisible(boolean visible)
          Sets a flag that controls whether or not the value-axis gridlines are drawn and fires a PropertyChangeEvent for the valueAxisGridlinesVisible property.
 void setValueAxisInverted(boolean inverted)
          Sets a flag that controls whether or not the value axis is inverted and fires a PropertyChangeEvent for the valueAxisInverted property.
 void setValueAxisLabel(java.lang.String label)
          Sets the label for the value axis and fires a PropertyChangeEvent for the valueAxisLabel property.
 void setValueAxisLineVisible(boolean visible)
          Sets the flag that controls whether or not the value axis draws a line running the length of the axis and fires a PropertyChangeEvent for the valueAxisLineVisible property.
 void setValueAxisLocation(org.jfree.chart.axis.AxisLocation location)
          Sets the axis location for the value axis and fires a PropertyChangeEvent for the valueAxisLocation property.
 void setValueAxisLowerMargin(double margin)
          Sets the lower margin for the value axis and fires a PropertyChangeEvent for the valueAxisLowerMargin property.
 void setValueAxisUpperMargin(double margin)
          Sets the upper margin for the value axis and fires a PropertyChangeEvent for the valueAxisUpperMargin property.
 
Methods inherited from class org.jfree.beans.AbstractChart
actionPerformed, addLegendClickListener, chartChanged, createDefaultChart, createPopup, doSaveAs, fireLegendClickEvent, getAntiAlias, getChartBackgroundImage, getChartBackgroundImageAlpha, getChartBackgroundPaint, getChartBorderPaint, getChartBorderStroke, getChartPadding, getLegendItemFont, getLegendItemPaint, getLegendPosition, getPlotBackgroundAlpha, getPlotBackgroundPaint, getScreenDataArea, getSource, getSourceFont, getSourcePaint, getSubtitle, getSubtitleFont, getSubtitlePaint, getTitle, getTitleFont, getTitlePaint, getToolTipText, isChartBorderVisible, isPlotOutlineVisible, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, paintComponent, removeLegendClickListener, restoreAutoBounds, restoreAutoDomainBounds, restoreAutoRangeBounds, setAntiAlias, setChartBackgroundImage, setChartBackgroundImageAlpha, setChartBackgroundPaint, setChartBorderPaint, setChartBorderStroke, setChartBorderVisible, setChartPadding, setLegendItemFont, setLegendItemPaint, setLegendPosition, setPlotBackgroundAlpha, setPlotBackgroundPaint, setPlotOutlineVisible, setSource, setSourceFont, setSourcePaint, setSubtitle, setSubtitleFont, setSubtitlePaint, setTitle, setTitleFont, setTitlePaint, setToolTipsEnabled, translateJava2DToScreen, translateScreenToJava2D, zoom
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AbstractCategoryChart

public AbstractCategoryChart()
Creates a new instance.

Method Detail

getOrientation

public org.jfree.chart.plot.PlotOrientation getOrientation()
Returns the orientation for the plot.

Returns:
The orientation for the plot.
See Also:
setOrientation(PlotOrientation)

setOrientation

public void setOrientation(org.jfree.chart.plot.PlotOrientation orientation)
Sets the orientation for the plot and fires a PropertyChangeEvent for the orientation property.

Parameters:
orientation - the orientation (null not permitted).
See Also:
getOrientation()

getCategoryAxisLabel

public java.lang.String getCategoryAxisLabel()
Returns the category axis label.

Returns:
The category axis label (possibly null).
See Also:
setCategoryAxisLabel(String)

setCategoryAxisLabel

public void setCategoryAxisLabel(java.lang.String label)
Sets the category axis label and fires a PropertyChangeEvent for the categoryAxisLabel property.

Parameters:
label - the label (null permitted).
See Also:
getCategoryAxisLabel()

getCategoryAxisLabelFont

public java.awt.Font getCategoryAxisLabelFont()
Returns the font used for the main label on the category axis.

Returns:
The font.
See Also:
setCategoryAxisLabelFont(Font)

setCategoryAxisLabelFont

public void setCategoryAxisLabelFont(java.awt.Font font)
Sets the font used for the main label on the category axis and fires a PropertyChangeEvent for the categoryAxisLabelFont property.

Parameters:
font - the font (null permitted).

getCategoryAxisLabelPaint

public java.awt.Paint getCategoryAxisLabelPaint()
Returns the paint used for the main label on the category axis.

Returns:
The paint.
See Also:
setCategoryAxisLabelPaint(Paint)

setCategoryAxisLabelPaint

public void setCategoryAxisLabelPaint(java.awt.Paint paint)
Sets the paint used for the main label on the category axis and fires a PropertyChangeEvent for the categoryAxisLabelPaint property.

Parameters:
paint - the paint (null not permitted).
See Also:
getCategoryAxisLabelPaint()

getCategoryAxisLowerMargin

public double getCategoryAxisLowerMargin()
Returns the lower margin for the category axis.

Returns:
The lower margin.
See Also:
setCategoryAxisLowerMargin(double)

setCategoryAxisLowerMargin

public void setCategoryAxisLowerMargin(double margin)
Sets the lower margin for the category axis and fires a PropertyChangeEvent for the categoryAxisLowerMargin property.

Parameters:
margin - the margin.
See Also:
getCategoryAxisLowerMargin()

getCategoryAxisUpperMargin

public double getCategoryAxisUpperMargin()
Returns the upper margin for the category axis.

Returns:
The upper margin for the category axis.
See Also:
setCategoryAxisUpperMargin(double)

setCategoryAxisUpperMargin

public void setCategoryAxisUpperMargin(double margin)
Sets the upper margin for the category axis and fires a PropertyChangeEvent for the categoryAxisUpperMargin property.

Parameters:
margin - the margin.
See Also:
getCategoryAxisUpperMargin()

getCategoryAxisMargin

public double getCategoryAxisMargin()
Returns the margin between categories along the axis.

Returns:
The margin.
See Also:
setCategoryAxisMargin(double)

setCategoryAxisMargin

public void setCategoryAxisMargin(double margin)
Sets the total space allocated to the margin between categories along the axis and fires a PropertyChangeEvent for the categoryAxisMargin property.

Parameters:
margin - the margin.
See Also:
getCategoryAxisMargin()

getValueAxisLabel

public java.lang.String getValueAxisLabel()
Returns the label for the value axis.

Returns:
The label for the value axis.
See Also:
setValueAxisLabel(String)

setValueAxisLabel

public void setValueAxisLabel(java.lang.String label)
Sets the label for the value axis and fires a PropertyChangeEvent for the valueAxisLabel property.

Parameters:
label - the label.
See Also:
getValueAxisLabel()

isValueAxisInverted

public boolean isValueAxisInverted()
Returns true if the value axis is inverted, and false otherwise.

Returns:
A boolean.
See Also:
setValueAxisInverted(boolean)

setValueAxisInverted

public void setValueAxisInverted(boolean inverted)
Sets a flag that controls whether or not the value axis is inverted and fires a PropertyChangeEvent for the valueAxisInverted property.

Parameters:
inverted - the new flag value.
See Also:
isValueAxisInverted()

getValueAxisLowerMargin

public double getValueAxisLowerMargin()
Returns the lower margin for the value axis.

Returns:
The lower margin.
See Also:
setValueAxisLowerMargin(double)

setValueAxisLowerMargin

public void setValueAxisLowerMargin(double margin)
Sets the lower margin for the value axis and fires a PropertyChangeEvent for the valueAxisLowerMargin property.

Parameters:
margin - the margin.
See Also:
getValueAxisLowerMargin()

getValueAxisUpperMargin

public double getValueAxisUpperMargin()
Returns the upper margin for the value axis.

Returns:
The upper margin for the value axis.
See Also:
setValueAxisUpperMargin(double)

setValueAxisUpperMargin

public void setValueAxisUpperMargin(double margin)
Sets the upper margin for the value axis and fires a PropertyChangeEvent for the valueAxisUpperMargin property.

Parameters:
margin - the margin.
See Also:
getValueAxisUpperMargin()

isValueAxisGridlinesVisible

public boolean isValueAxisGridlinesVisible()
Returns true if the value axis gridlines are visible, and false otherwise.

Returns:
A boolean.
See Also:
setValueAxisGridlinesVisible(boolean)

setValueAxisGridlinesVisible

public void setValueAxisGridlinesVisible(boolean visible)
Sets a flag that controls whether or not the value-axis gridlines are drawn and fires a PropertyChangeEvent for the valueAxisGridlinesVisible property.

Parameters:
visible - the new flag value.
See Also:
isValueAxisGridlinesVisible()

isValueAxisLineVisible

public boolean isValueAxisLineVisible()
Returns the flag that controls whether or not the value axis draws a line running the length of the axis.

Returns:
A boolean.
See Also:
setValueAxisLineVisible(boolean)

setValueAxisLineVisible

public void setValueAxisLineVisible(boolean visible)
Sets the flag that controls whether or not the value axis draws a line running the length of the axis and fires a PropertyChangeEvent for the valueAxisLineVisible property.

Parameters:
visible - the new flag value.
See Also:
isValueAxisLineVisible()

isCategoryAxisLineVisible

public boolean isCategoryAxisLineVisible()
Returns a flag that conrtols whether or not the category axis draws a line running the length of the axis.

Returns:
A boolean.
See Also:
setCategoryAxisLineVisible(boolean)

setCategoryAxisLineVisible

public void setCategoryAxisLineVisible(boolean visible)
Sets the flag that controls whether or not the category axis draws a line running the length of the axis and fires a PropertyChangeEvent for the categoryAxisLineVisible property.

Parameters:
visible - the new flag value.
See Also:
isCategoryAxisLineVisible()

getCategoryAxisLocation

public org.jfree.chart.axis.AxisLocation getCategoryAxisLocation()
Returns the permitted axis locations for the category axis.

Returns:
The axis location.
See Also:
setCategoryAxisLocation(AxisLocation)

setCategoryAxisLocation

public void setCategoryAxisLocation(org.jfree.chart.axis.AxisLocation location)
Sets the axis location for the category axis and fires a PropertyChangeEvent for the categoryAxisLocation property.

Parameters:
location - the location (null not permitted).
See Also:
getCategoryAxisLocation()

getValueAxisLocation

public org.jfree.chart.axis.AxisLocation getValueAxisLocation()
Returns the permitted axis locations for the value axis.

Returns:
The axis location.
See Also:
setValueAxisLocation(AxisLocation)

setValueAxisLocation

public void setValueAxisLocation(org.jfree.chart.axis.AxisLocation location)
Sets the axis location for the value axis and fires a PropertyChangeEvent for the valueAxisLocation property.

Parameters:
location - the location (null not permitted).

getToolTipFormat

public java.lang.String getToolTipFormat()
Returns the format string for the item tool tips.

Returns:
The format string.
See Also:
setToolTipFormat(String)

setToolTipFormat

public void setToolTipFormat(java.lang.String format)
Sets the format string for the section tool tips and fires a PropertyChangeEvent for the toolTipFormat property.

Parameters:
format - the format string.
See Also:
getToolTipFormat()

addCategoryItemClickListener

public void addCategoryItemClickListener(CategoryItemClickListener listener)
Registers a listener to receive notification of category item clicks.

Parameters:
listener - the listener (null not permitted).

removeCategoryItemClickListener

public void removeCategoryItemClickListener(CategoryItemClickListener listener)
Unregisters a listener so that it no longer receives notification of category item clicks.

Parameters:
listener - the listener (null not permitted).

fireCategoryItemClickEvent

public void fireCategoryItemClickEvent(CategoryItemClickEvent event)
Fires a category item click event.

Parameters:
event - the event.

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent event)
If the user clicks on the chart, see if that translates into an event that we report...

Specified by:
mouseClicked in interface java.awt.event.MouseListener
Overrides:
mouseClicked in class AbstractChart
Parameters:
event - the event.