001/* =========================================================== 002 * JFreeChart : a free chart library for the Java(tm) platform 003 * =========================================================== 004 * 005 * (C) Copyright 2000-2017, by Object Refinery Limited and Contributors. 006 * 007 * Project Info: http://www.jfree.org/jfreechart/index.html 008 * 009 * This library is free software; you can redistribute it and/or modify it 010 * under the terms of the GNU Lesser General Public License as published by 011 * the Free Software Foundation; either version 2.1 of the License, or 012 * (at your option) any later version. 013 * 014 * This library is distributed in the hope that it will be useful, but 015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 017 * License for more details. 018 * 019 * You should have received a copy of the GNU Lesser General Public 020 * License along with this library; if not, write to the Free Software 021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 022 * USA. 023 * 024 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 025 * Other names may be trademarks of their respective owners.] 026 * 027 * -------------- 028 * DateTitle.java 029 * -------------- 030 * (C) Copyright 2000-2017, by David Berry and Contributors. 031 * 032 * Original Author: David Berry; 033 * Contributor(s): David Gilbert (for Object Refinery Limited); 034 * 035 * Changes (from 18-Sep-2001) 036 * -------------------------- 037 * 18-Sep-2001 : Added standard header (DG); 038 * 09-Jan-2002 : Updated Javadoc comments (DG); 039 * 07-Feb-2002 : Changed blank space around title from Insets --> Spacer, to 040 * allow for relative or absolute spacing (DG); 041 * 26-Sep-2002 : Fixed errors reported by Checkstyle (DG); 042 * 31-Jan-2005 : Updated for changes to super class (DG); 043 * ------------- JFREECHART 1.0.x --------------------------------------------- 044 * 02-Feb-2007 : Removed author tags all over JFreeChart sources (DG); 045 * 046 */ 047 048package org.jfree.chart.title; 049 050import java.awt.Color; 051import java.awt.Font; 052import java.awt.Paint; 053import java.io.Serializable; 054import java.text.DateFormat; 055import java.util.Date; 056import java.util.Locale; 057 058/** 059 * A chart title that displays the date. 060 * <p> 061 * Keep in mind that a chart can have several titles, and that they can appear 062 * at the top, left, right or bottom of the chart - a {@code DateTitle} 063 * will commonly appear at the bottom of a chart, although you can place it 064 * anywhere. 065 * <P> 066 * By specifying the locale, dates are formatted to the correct standard for 067 * the given locale. For example, a date would appear as "January 17, 2000" in 068 * the US, but "17 January 2000" in most European locales. 069 */ 070import org.jfree.chart.ui.HorizontalAlignment; 071import org.jfree.chart.ui.RectangleEdge; 072import org.jfree.chart.ui.RectangleInsets; 073import org.jfree.chart.ui.VerticalAlignment; 074public class DateTitle extends TextTitle implements Serializable { 075 076 /** For serialization. */ 077 private static final long serialVersionUID = -465434812763159881L; 078 079 /** 080 * Creates a new chart title that displays the current date in the default 081 * (LONG) format for the locale, positioned to the bottom right of the 082 * chart. 083 * <P> 084 * The color will be black in 12 point, plain Helvetica font (maps to Arial 085 * on Win32 systems without Helvetica). 086 */ 087 public DateTitle() { 088 this(DateFormat.LONG); 089 } 090 091 /** 092 * Creates a new chart title that displays the current date with the 093 * specified style (for the default locale). 094 * <P> 095 * The date style should be one of: {@code SHORT}, 096 * {@code MEDIUM}, {@code LONG} or {@code FULL} 097 * (defined in {@code java.util.DateFormat}). 098 * 099 * @param style the date style. 100 */ 101 public DateTitle(int style) { 102 this(style, Locale.getDefault(), new Font("Dialog", Font.PLAIN, 12), 103 Color.BLACK); 104 } 105 106 /** 107 * Creates a new chart title that displays the current date. 108 * <p> 109 * The date style should be one of: {@code SHORT}, 110 * {@code MEDIUM}, {@code LONG} or {@code FULL} (defined 111 * in {@code java.util.DateFormat}). 112 * <P> 113 * For the locale, you can use {@code Locale.getDefault()} for the 114 * default locale. 115 * 116 * @param style the date style. 117 * @param locale the locale. 118 * @param font the font. 119 * @param paint the text color. 120 */ 121 public DateTitle(int style, Locale locale, Font font, Paint paint) { 122 this(style, locale, font, paint, RectangleEdge.BOTTOM, 123 HorizontalAlignment.RIGHT, VerticalAlignment.CENTER, 124 Title.DEFAULT_PADDING); 125 } 126 127 /** 128 * Creates a new chart title that displays the current date. 129 * <p> 130 * The date style should be one of: {@code SHORT}, 131 * {@code MEDIUM}, {@code LONG} or {@code FULL} (defined 132 * in {@code java.util.DateFormat}). 133 * <P> 134 * For the locale, you can use {@code Locale.getDefault()} for the 135 * default locale. 136 * 137 * @param style the date style. 138 * @param locale the locale. 139 * @param font the font (not null). 140 * @param paint the text color (not null). 141 * @param position the relative location of this title (use constants in 142 * Title). 143 * @param horizontalAlignment the horizontal text alignment of this title 144 * (use constants in Title). 145 * @param verticalAlignment the vertical text alignment of this title (use 146 * constants in Title). 147 * @param padding determines the blank space around the outside of the 148 * title (not null). 149 */ 150 public DateTitle(int style, Locale locale, Font font, Paint paint, 151 RectangleEdge position, HorizontalAlignment horizontalAlignment, 152 VerticalAlignment verticalAlignment, RectangleInsets padding) { 153 super(DateFormat.getDateInstance(style, locale).format(new Date()), 154 font, paint, position, horizontalAlignment, verticalAlignment, 155 padding); 156 } 157 158 /** 159 * Set the format of the date. 160 * <P> 161 * The date style should be one of: {@code SHORT}, 162 * {@code MEDIUM}, {@code LONG} or {@code FULL} (defined 163 * in {@code java.util.DateFormat}). 164 * <P> 165 * For the locale, you can use {@code Locale.getDefault()} for the 166 * default locale. 167 * 168 * @param style the date style. 169 * @param locale the locale. 170 */ 171 public void setDateFormat(int style, Locale locale) { 172 setText(DateFormat.getDateInstance(style, locale).format(new Date())); 173 } 174 175}