DateTitle

extends TextTitle
implements Serializable

java.lang.Object
↳	org.jfree.chart.block.AbstractBlock
	↳	org.jfree.chart.title.Title
		↳	org.jfree.chart.title.TextTitle
			↳	org.jfree.chart.title.DateTitle

Class Overview

A chart title that displays the date.

Keep in mind that a chart can have several titles, and that they can appear at the top, left, right or bottom of the chart - a DateTitle will commonly appear at the bottom of a chart, although you can place it anywhere.

By specifying the locale, dates are formatted to the correct standard for the given locale. For example, a date would appear as "January 17, 2000" in the US, but "17 January 2000" in most European locales.

Summary

[Expand]

Inherited Fields

From class org.jfree.chart.title.TextTitle

From class org.jfree.chart.title.Title

Public Constructors
	DateTitle() Creates a new chart title that displays the current date in the default (LONG) format for the locale, positioned to the bottom right of the chart.
	DateTitle(int style) Creates a new chart title that displays the current date with the specified style (for the default locale).
	DateTitle(int style, Locale locale, Font font, Paint paint) Creates a new chart title that displays the current date.
	DateTitle(int style, Locale locale, Font font, Paint paint, RectangleEdge position, HorizontalAlignment horizontalAlignment, VerticalAlignment verticalAlignment, RectangleInsets padding) Creates a new chart title that displays the current date.

Public Methods
void	setDateFormat(int style, Locale locale) Set the format of the date.

[Expand]

Inherited Methods

From class org.jfree.chart.title.TextTitle

Size2D	arrange(Graphics2D g2, RectangleConstraint constraint) Arranges the contents of the block, within the given constraints, and returns the block size.
Size2D	arrangeFN(Graphics2D g2, double w) Arranges the content for this title assuming a fixed width and no bounds on the height, and returns the required size.
Size2D	arrangeNN(Graphics2D g2) Arranges the content for this title assuming no bounds on the width or the height, and returns the required size.
Size2D	arrangeRN(Graphics2D g2, Range widthRange) Arranges the content for this title assuming a range constraint for the width and no bounds on the height, and returns the required size.
Size2D	arrangeRR(Graphics2D g2, Range widthRange, Range heightRange) Returns the content size for the title.
Object	clone() Returns a clone of this object.
void	draw(Graphics2D g2, Rectangle2D area) Draws the title on a Java 2D graphics device (such as the screen or a printer).
Object	draw(Graphics2D g2, Rectangle2D area, Object params) Draws the block within the specified area.
void	drawHorizontal(Graphics2D g2, Rectangle2D area) Draws a the title horizontally within the specified area.
void	drawVertical(Graphics2D g2, Rectangle2D area) Draws a the title vertically within the specified area.
boolean	equals(Object obj) Tests this title for equality with another object.
Paint	getBackgroundPaint() Returns the background paint.
boolean	getExpandToFitSpace() Returns the flag that controls whether or not the title expands to fit the available space.
Font	getFont() Returns the font used to display the title string.
int	getMaximumLinesToDisplay() Returns the maximum number of lines to display.
Paint	getPaint() Returns the paint used to display the title string.
String	getText() Returns the title text.
HorizontalAlignment	getTextAlignment() Returns the text alignment.
String	getToolTipText() Returns the tool tip text.
String	getURLText() Returns the URL text.
int	hashCode() Returns a hash code.
void	setBackgroundPaint(Paint paint) Sets the background paint and sends a `TitleChangeEvent` to all registered listeners.
void	setExpandToFitSpace(boolean expand) Sets the flag that controls whether the title expands to fit the available space, and sends a `TitleChangeEvent` to all registered listeners.
void	setFont(Font font) Sets the font used to display the title string.
void	setMaximumLinesToDisplay(int max) Sets the maximum number of lines to display and sends a `TitleChangeEvent` to all registered listeners.
void	setPaint(Paint paint) Sets the paint used to display the title string.
void	setText(String text) Sets the title to the specified text and sends a `TitleChangeEvent` to all registered listeners.
void	setTextAlignment(HorizontalAlignment alignment) Sets the text alignment and sends a `TitleChangeEvent` to all registered listeners.
void	setToolTipText(String text) Sets the tool tip text to the specified text and sends a `TitleChangeEvent` to all registered listeners.
void	setURLText(String text) Sets the URL text to the specified text and sends a `TitleChangeEvent` to all registered listeners.

From class org.jfree.chart.title.Title

void	addChangeListener(TitleChangeListener listener) Registers an object for notification of changes to the title.
Object	clone() Returns a clone of the title.
abstract void	draw(Graphics2D g2, Rectangle2D area) Draws the title on a Java 2D graphics device (such as the screen or a printer).
boolean	equals(Object obj) Tests an object for equality with this title.
HorizontalAlignment	getHorizontalAlignment() Returns the horizontal alignment of the title.
boolean	getNotify() Returns the flag that indicates whether or not the notification mechanism is enabled.
RectangleEdge	getPosition() Returns the position of the title.
VerticalAlignment	getVerticalAlignment() Returns the vertical alignment of the title.
int	hashCode() Returns a hashcode for the title.
boolean	isVisible() Returns a flag that controls whether or not the title should be drawn.
void	notifyListeners(TitleChangeEvent event) Notifies all registered listeners that the chart title has changed in some way.
void	removeChangeListener(TitleChangeListener listener) Unregisters an object for notification of changes to the chart title.
void	setHorizontalAlignment(HorizontalAlignment alignment) Sets the horizontal alignment for the title and sends a `TitleChangeEvent` to all registered listeners.
void	setNotify(boolean flag) Sets the flag that indicates whether or not the notification mechanism is enabled.
void	setPosition(RectangleEdge position) Sets the position for the title and sends a `TitleChangeEvent` to all registered listeners.
void	setVerticalAlignment(VerticalAlignment alignment) Sets the vertical alignment for the title, and notifies any registered listeners of the change.
void	setVisible(boolean visible) Sets a flag that controls whether or not the title should be drawn, and sends a `TitleChangeEvent` to all registered listeners.

From class org.jfree.chart.block.AbstractBlock

Size2D	arrange(Graphics2D g2) Arranges the contents of the block, with no constraints, and returns the block size.
Size2D	arrange(Graphics2D g2, RectangleConstraint constraint) Arranges the contents of the block, within the given constraints, and returns the block size.
double	calculateTotalHeight(double contentHeight) Adds the margin, border and padding to the specified content height.
double	calculateTotalWidth(double contentWidth) Adds the margin, border and padding to the specified content width.
Object	clone() Returns a clone of this block.
void	drawBorder(Graphics2D g2, Rectangle2D area) Draws the border around the perimeter of the specified area.
boolean	equals(Object obj) Tests this block for equality with an arbitrary object.
BlockBorder	getBorder() This method is deprecated. Use `getFrame()` instead.
Rectangle2D	getBounds() Returns the current bounds of the block.
double	getContentXOffset() Returns the x-offset for the content within the block.
double	getContentYOffset() Returns the y-offset for the content within the block.
BlockFrame	getFrame() Returns the current frame (border).
double	getHeight() Returns the natural height of the block, if this is known in advance.
String	getID() Returns the id.
RectangleInsets	getMargin() Returns the margin.
RectangleInsets	getPadding() Returns the padding.
double	getWidth() Returns the natural width of the block, if this is known in advance.
void	setBorder(BlockBorder border) This method is deprecated. Use `setFrame(BlockFrame)` instead.
void	setBorder(double top, double left, double bottom, double right) Sets a black border with the specified line widths.
void	setBounds(Rectangle2D bounds) Sets the bounds of the block.
void	setFrame(BlockFrame frame) Sets the frame (or border).
void	setHeight(double height) Sets the natural width of the block, if this is known in advance.
void	setID(String id) Sets the id for the block.
void	setMargin(RectangleInsets margin) Sets the margin (use RectangleInsets#ZERO_INSETS for no padding).
void	setMargin(double top, double left, double bottom, double right) Sets the margin.
void	setPadding(double top, double left, double bottom, double right) Sets the padding.
void	setPadding(RectangleInsets padding) Sets the padding (use RectangleInsets#ZERO_INSETS for no padding).
void	setWidth(double width) Sets the natural width of the block, if this is known in advance.
RectangleConstraint	toContentConstraint(RectangleConstraint c) Returns a constraint for the content of this block that will result in the bounds of the block matching the specified constraint.
Rectangle2D	trimBorder(Rectangle2D area) Reduces the specified area by the amount of space consumed by the border.
Rectangle2D	trimMargin(Rectangle2D area) Reduces the specified area by the amount of space consumed by the margin.
Rectangle2D	trimPadding(Rectangle2D area) Reduces the specified area by the amount of space consumed by the padding.
double	trimToContentHeight(double fixedHeight) Calculate the height available for content after subtracting the margin, border and padding space from the specified fixed height.
double	trimToContentWidth(double fixedWidth) Calculate the width available for content after subtracting the margin, border and padding space from the specified fixed width.

From class java.lang.Object

From interface org.jfree.chart.block.Block

Public Constructors

public DateTitle ()

Creates a new chart title that displays the current date in the default (LONG) format for the locale, positioned to the bottom right of the chart.

The color will be black in 12 point, plain Helvetica font (maps to Arial on Win32 systems without Helvetica).

public DateTitle (int style)

Creates a new chart title that displays the current date with the specified style (for the default locale).

The date style should be one of: SHORT, MEDIUM, LONG or FULL (defined in java.util.DateFormat).


  
      Parameters
      
        
          style
          the date style.






 
    
      
        public 
         
         
         
         
        
      
      DateTitle
      (int style, Locale locale, Font font, Paint paint)
    
      
        


        
  

      
    
      
  Creates a new chart title that displays the current date.
 

 The date style should be one of:  SHORT,
 MEDIUM, LONG or FULL (defined
 in java.util.DateFormat).
 

 For the locale, you can use Locale.getDefault() for the
 default locale.

  
      Parameters
      
        
          style
          the date style.
        
        
          locale
          the locale.
        
        
          font
          the font.
        
        
          paint
          the text color.

        
      
  

    






 
    
      
        public 
         
         
         
         
        
      
      DateTitle
      (int style, Locale locale, Font font, Paint paint, RectangleEdge position, HorizontalAlignment horizontalAlignment, VerticalAlignment verticalAlignment, RectangleInsets padding)
    
      
        


        
  

      
    
      
  Creates a new chart title that displays the current date.
 

 The date style should be one of:  SHORT,
 MEDIUM, LONG or FULL (defined
 in java.util.DateFormat).
 

 For the locale, you can use Locale.getDefault() for the
 default locale.

  
      Parameters
      
        
          style
          the date style.
        
        
          locale
          the locale.
        
        
          font
          the font (not null).
        
        
          paint
          the text color (not null).
        
        
          position
          the relative location of this title (use constants in
                  Title).
        
        
          horizontalAlignment
          the horizontal text alignment of this title
                             (use constants in Title).
        
        
          verticalAlignment
          the vertical text alignment of this title (use
                           constants in Title).
        
        
          padding
          determines the blank space around the outside of the
                 title (not null).

        
      
  

    















Public Methods





 
    
      
        public 
         
         
         
         
        void
      
      setDateFormat
      (int style, Locale locale)
    
      
        


        
  

      
    
      
  Set the format of the date.
 

 The date style should be one of:  SHORT,
 MEDIUM, LONG or FULL (defined
 in java.util.DateFormat).
 

 For the locale, you can use Locale.getDefault() for the
 default locale.

  
      Parameters
      
        
          style
          the date style.
        
        
          locale
          the locale.

        
      
  

    















Generated by Doclava.

style	the date style.
locale	the locale.
font	the font.
paint	the text color.

Classes

DateTitle

Class Overview

Summary

Public Constructors

public DateTitle ()

public DateTitle (int style)

Parameters

public DateTitle (int style, Locale locale, Font font, Paint paint)

Parameters

public DateTitle (int style, Locale locale, Font font, Paint paint, RectangleEdge position, HorizontalAlignment horizontalAlignment, VerticalAlignment verticalAlignment, RectangleInsets padding)

Parameters

Public Methods

public void setDateFormat (int style, Locale locale)

Parameters