Plot
org.jfree.chart.plot

Class Plot

    • Field Detail

      • ZERO

        public static final Number ZERO
        Useful constant representing zero.
      • DEFAULT_INSETS

        public static final org.jfree.ui.RectangleInsets DEFAULT_INSETS
        The default insets.
      • DEFAULT_OUTLINE_STROKE

        public static final Stroke DEFAULT_OUTLINE_STROKE
        The default outline stroke.
      • DEFAULT_OUTLINE_PAINT

        public static final Paint DEFAULT_OUTLINE_PAINT
        The default outline color.
      • DEFAULT_FOREGROUND_ALPHA

        public static final float DEFAULT_FOREGROUND_ALPHA
        The default foreground alpha transparency.
        See Also:
        Constant Field Values
      • DEFAULT_BACKGROUND_ALPHA

        public static final float DEFAULT_BACKGROUND_ALPHA
        The default background alpha transparency.
        See Also:
        Constant Field Values
      • DEFAULT_BACKGROUND_PAINT

        public static final Paint DEFAULT_BACKGROUND_PAINT
        The default background color.
      • MINIMUM_WIDTH_TO_DRAW

        public static final int MINIMUM_WIDTH_TO_DRAW
        The minimum width at which the plot should be drawn.
        See Also:
        Constant Field Values
      • MINIMUM_HEIGHT_TO_DRAW

        public static final int MINIMUM_HEIGHT_TO_DRAW
        The minimum height at which the plot should be drawn.
        See Also:
        Constant Field Values
      • DEFAULT_LEGEND_ITEM_BOX

        public static final Shape DEFAULT_LEGEND_ITEM_BOX
        A default box shape for legend items.
      • DEFAULT_LEGEND_ITEM_CIRCLE

        public static final Shape DEFAULT_LEGEND_ITEM_CIRCLE
        A default circle shape for legend items.
    • Method Detail

      • setNoDataMessage

        public void setNoDataMessage(String message)
        Sets the message that is displayed when the dataset is empty or null, and sends a PlotChangeEvent to all registered listeners.
        Parameters:
        message - the message (null permitted).
        See Also:
        getNoDataMessage()
      • setNoDataMessageFont

        public void setNoDataMessageFont(Font font)
        Sets the font used to display the 'no data' message and sends a PlotChangeEvent to all registered listeners.
        Parameters:
        font - the font (null not permitted).
        See Also:
        getNoDataMessageFont()
      • setNoDataMessagePaint

        public void setNoDataMessagePaint(Paint paint)
        Sets the paint used to display the 'no data' message and sends a PlotChangeEvent to all registered listeners.
        Parameters:
        paint - the paint (null not permitted).
        See Also:
        getNoDataMessagePaint()
      • getPlotType

        public abstract String getPlotType()
        Returns a short string describing the plot type.

        Note: this gets used in the chart property editing user interface, but there needs to be a better mechanism for identifying the plot type.

        Returns:
        A short string describing the plot type (never null).
      • getParent

        public Plot getParent()
        Returns the parent plot (or null if this plot is not part of a combined plot).
        Returns:
        The parent plot.
        See Also:
        setParent(Plot), getRootPlot()
      • setParent

        public void setParent(Plot parent)
        Sets the parent plot. This method is intended for internal use, you shouldn't need to call it directly.
        Parameters:
        parent - the parent plot (null permitted).
        See Also:
        getParent()
      • getRootPlot

        public Plot getRootPlot()
        Returns the root plot.
        Returns:
        The root plot.
        See Also:
        getParent()
      • isSubplot

        public boolean isSubplot()
        Returns true if this plot is part of a combined plot structure (that is, getParent() returns a non-null value), and false otherwise.
        Returns:
        true if this plot is part of a combined plot structure.
        See Also:
        getParent()
      • getInsets

        public org.jfree.ui.RectangleInsets getInsets()
        Returns the insets for the plot area.
        Returns:
        The insets (never null).
        See Also:
        setInsets(RectangleInsets)
      • setInsets

        public void setInsets(org.jfree.ui.RectangleInsets insets,             boolean notify)
        Sets the insets for the plot and, if requested, and sends a PlotChangeEvent to all registered listeners.
        Parameters:
        insets - the new insets (null not permitted).
        notify - a flag that controls whether the registered listeners are notified.
        See Also:
        getInsets(), setInsets(RectangleInsets)
      • getBackgroundPaint

        public Paint getBackgroundPaint()
        Returns the background color of the plot area.
        Returns:
        The paint (possibly null).
        See Also:
        setBackgroundPaint(Paint)
      • setBackgroundPaint

        public void setBackgroundPaint(Paint paint)
        Sets the background color of the plot area and sends a PlotChangeEvent to all registered listeners.
        Parameters:
        paint - the paint (null permitted).
        See Also:
        getBackgroundPaint()
      • getBackgroundAlpha

        public float getBackgroundAlpha()
        Returns the alpha transparency of the plot area background.
        Returns:
        The alpha transparency.
        See Also:
        setBackgroundAlpha(float)
      • setBackgroundAlpha

        public void setBackgroundAlpha(float alpha)
        Sets the alpha transparency of the plot area background, and notifies registered listeners that the plot has been modified.
        Parameters:
        alpha - the new alpha value (in the range 0.0f to 1.0f).
        See Also:
        getBackgroundAlpha()
      • setDrawingSupplier

        public void setDrawingSupplier(DrawingSupplier supplier)
        Sets the drawing supplier for the plot and sends a PlotChangeEvent to all registered listeners. The drawing supplier is responsible for supplying a limitless (possibly repeating) sequence of Paint, Stroke and Shape objects that the plot's renderer(s) can use to populate its (their) tables.
        Parameters:
        supplier - the new supplier.
        See Also:
        getDrawingSupplier()
      • setDrawingSupplier

        public void setDrawingSupplier(DrawingSupplier supplier,                      boolean notify)
        Sets the drawing supplier for the plot and, if requested, sends a PlotChangeEvent to all registered listeners. The drawing supplier is responsible for supplying a limitless (possibly repeating) sequence of Paint, Stroke and Shape objects that the plot's renderer(s) can use to populate its (their) tables.
        Parameters:
        supplier - the new supplier.
        notify - notify listeners?
        See Also:
        getDrawingSupplier()
      • getBackgroundImage

        public Image getBackgroundImage()
        Returns the background image that is used to fill the plot's background area.
        Returns:
        The image (possibly null).
        See Also:
        setBackgroundImage(Image)
      • setBackgroundImage

        public void setBackgroundImage(Image image)
        Sets the background image for the plot and sends a PlotChangeEvent to all registered listeners.
        Parameters:
        image - the image (null permitted).
        See Also:
        getBackgroundImage()
      • getBackgroundImageAlignment

        public int getBackgroundImageAlignment()
        Returns the background image alignment. Alignment constants are defined in the org.jfree.ui.Align class in the JCommon class library.
        Returns:
        The alignment.
        See Also:
        setBackgroundImageAlignment(int)
      • setBackgroundImageAlignment

        public void setBackgroundImageAlignment(int alignment)
        Sets the alignment for the background image and sends a PlotChangeEvent to all registered listeners. Alignment options are defined by the Align class in the JCommon class library.
        Parameters:
        alignment - the alignment.
        See Also:
        getBackgroundImageAlignment()
      • getBackgroundImageAlpha

        public float getBackgroundImageAlpha()
        Returns the alpha transparency used to draw the background image. This is a value in the range 0.0f to 1.0f, where 0.0f is fully transparent and 1.0f is fully opaque.
        Returns:
        The alpha transparency.
        See Also:
        setBackgroundImageAlpha(float)
      • setBackgroundImageAlpha

        public void setBackgroundImageAlpha(float alpha)
        Sets the alpha transparency used when drawing the background image.
        Parameters:
        alpha - the alpha transparency (in the range 0.0f to 1.0f, where 0.0f is fully transparent, and 1.0f is fully opaque).
        Throws:
        IllegalArgumentException - if alpha is not within the specified range.
        See Also:
        getBackgroundImageAlpha()
      • isOutlineVisible

        public boolean isOutlineVisible()
        Returns the flag that controls whether or not the plot outline is drawn. The default value is true. Note that for historical reasons, the plot's outline paint and stroke can take on null values, in which case the outline will not be drawn even if this flag is set to true.
        Returns:
        The outline visibility flag.
        See Also:
        setOutlineVisible(boolean)
      • setOutlineVisible

        public void setOutlineVisible(boolean visible)
        Sets the flag that controls whether or not the plot's outline is drawn, and sends a PlotChangeEvent to all registered listeners.
        Parameters:
        visible - the new flag value.
        See Also:
        isOutlineVisible()
      • getOutlineStroke

        public Stroke getOutlineStroke()
        Returns the stroke used to outline the plot area.
        Returns:
        The stroke (possibly null).
        See Also:
        setOutlineStroke(Stroke)
      • setOutlineStroke

        public void setOutlineStroke(Stroke stroke)
        Sets the stroke used to outline the plot area and sends a PlotChangeEvent to all registered listeners. If you set this attribute to null, no outline will be drawn.
        Parameters:
        stroke - the stroke (null permitted).
        See Also:
        getOutlineStroke()
      • getOutlinePaint

        public Paint getOutlinePaint()
        Returns the color used to draw the outline of the plot area.
        Returns:
        The color (possibly null).
        See Also:
        setOutlinePaint(Paint)
      • setOutlinePaint

        public void setOutlinePaint(Paint paint)
        Sets the paint used to draw the outline of the plot area and sends a PlotChangeEvent to all registered listeners. If you set this attribute to null, no outline will be drawn.
        Parameters:
        paint - the paint (null permitted).
        See Also:
        getOutlinePaint()
      • getForegroundAlpha

        public float getForegroundAlpha()
        Returns the alpha-transparency for the plot foreground.
        Returns:
        The alpha-transparency.
        See Also:
        setForegroundAlpha(float)
      • setForegroundAlpha

        public void setForegroundAlpha(float alpha)
        Sets the alpha-transparency for the plot and sends a PlotChangeEvent to all registered listeners.
        Parameters:
        alpha - the new alpha transparency.
        See Also:
        getForegroundAlpha()
      • isNotify

        public boolean isNotify()
        Returns a flag that controls whether or not change events are sent to registered listeners.
        Returns:
        A boolean.
        See Also:
        setNotify(boolean)
      • setNotify

        public void setNotify(boolean notify)
        Sets a flag that controls whether or not listeners receive PlotChangeEvent notifications.
        Parameters:
        notify - a boolean.
        See Also:
        isNotify()
      • notifyListeners

        public void notifyListeners(PlotChangeEvent event)
        Notifies all registered listeners that the plot has been modified.
        Parameters:
        event - information about the change event.
      • draw

        public abstract void draw(Graphics2D g2,        Rectangle2D area,        Point2D anchor,        PlotState parentState,        PlotRenderingInfo info)
        Draws the plot within the specified area. The anchor is a point on the chart that is specified externally (for instance, it may be the last point of the last mouse click performed by the user) - plots can use or ignore this value as they see fit.

        Subclasses need to provide an implementation of this method, obviously.
        Parameters:
        g2 - the graphics device.
        area - the plot area.
        anchor - the anchor point (null permitted).
        parentState - the parent state (if any).
        info - carries back plot rendering info.
      • drawBackground

        public void drawBackground(Graphics2D g2,                  Rectangle2D area)
        Draws the plot background (the background color and/or image).

        This method will be called during the chart drawing process and is declared public so that it can be accessed by the renderers used by certain subclasses. You shouldn't need to call this method directly.

        Parameters:
        g2 - the graphics device.
        area - the area within which the plot should be drawn.
      • drawOutline

        public void drawOutline(Graphics2D g2,               Rectangle2D area)
        Draws the plot outline. This method will be called during the chart drawing process and is declared public so that it can be accessed by the renderers used by certain subclasses. You shouldn't need to call this method directly.
        Parameters:
        g2 - the graphics device.
        area - the area within which the plot should be drawn.
      • handleClick

        public void handleClick(int x,               int y,               PlotRenderingInfo info)
        Handles a 'click' on the plot. Since the plot does not maintain any information about where it has been drawn, the plot rendering info is supplied as an argument so that the plot dimensions can be determined.
        Parameters:
        x - the x coordinate (in Java2D space).
        y - the y coordinate (in Java2D space).
        info - an object containing information about the dimensions of the plot.
      • zoom

        public void zoom(double percent)
        Performs a zoom on the plot. Subclasses should override if zooming is appropriate for the type of plot.
        Parameters:
        percent - the zoom percentage.
      • axisChanged

        public void axisChanged(AxisChangeEvent event)
        Receives notification of a change to one of the plot's axes.
        Specified by:
        axisChanged in interface AxisChangeListener
        Parameters:
        event - information about the event (not used here).
      • datasetChanged

        public void datasetChanged(DatasetChangeEvent event)
        Receives notification of a change to the plot's dataset.

        The plot reacts by passing on a plot change event to all registered listeners.

        Specified by:
        datasetChanged in interface DatasetChangeListener
        Parameters:
        event - information about the event (not used here).
      • equals

        public boolean equals(Object obj)
        Tests this plot for equality with another object.
        Overrides:
        equals in class Object
        Parameters:
        obj - the object (null permitted).
        Returns:
        true or false.
      • resolveDomainAxisLocation

        public static org.jfree.ui.RectangleEdge resolveDomainAxisLocation(AxisLocation location,                                                   PlotOrientation orientation)
        Resolves a domain axis location for a given plot orientation.
        Parameters:
        location - the location (null not permitted).
        orientation - the orientation (null not permitted).
        Returns:
        The edge (never null).
      • resolveRangeAxisLocation

        public static org.jfree.ui.RectangleEdge resolveRangeAxisLocation(AxisLocation location,                                                  PlotOrientation orientation)
        Resolves a range axis location for a given plot orientation.
        Parameters:
        location - the location (null not permitted).
        orientation - the orientation (null not permitted).
        Returns:
        The edge (never null).

SCaVis 2.2 © jWork.ORG