001: /**
002: * ===========================================
003: * JFreeReport : a free Java reporting library
004: * ===========================================
005: *
006: * Project Info: http://reporting.pentaho.org/
007: *
008: * (C) Copyright 2001-2007, by Object Refinery Ltd, Pentaho Corporation and Contributors.
009: *
010: * This library is free software; you can redistribute it and/or modify it under the terms
011: * of the GNU Lesser General Public License as published by the Free Software Foundation;
012: * either version 2.1 of the License, or (at your option) any later version.
013: *
014: * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
015: * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
016: * See the GNU Lesser General Public License for more details.
017: *
018: * You should have received a copy of the GNU Lesser General Public License along with this
019: * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
020: * Boston, MA 02111-1307, USA.
021: *
022: * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
023: * in the United States and other countries.]
024: *
025: * ------------
026: * ElementStyleKeys.java
027: * ------------
028: * (C) Copyright 2001-2007, by Object Refinery Ltd, Pentaho Corporation and Contributors.
029: */package org.jfree.report.style;
030:
031: import java.awt.Color;
032: import java.awt.Paint;
033: import java.awt.Stroke;
034: import java.awt.geom.Dimension2D;
035: import java.awt.geom.Point2D;
036:
037: import org.jfree.report.ElementAlignment;
038: import org.jfree.report.util.geom.StrictBounds;
039:
040: /**
041: * Creation-Date: 05.04.2007, 15:18:00
042: *
043: * @author Thomas Morgner
044: */
045: public class ElementStyleKeys {
046: public static final StyleKey BORDER_TOP_WIDTH = StyleKey
047: .getStyleKey("border-top-width", Float.class, false, false);
048: public static final StyleKey BORDER_TOP_STYLE = StyleKey
049: .getStyleKey("border-top-style", BorderStyle.class, false,
050: false);
051: public static final StyleKey BORDER_TOP_COLOR = StyleKey
052: .getStyleKey("border-top-color", Color.class, false, false);
053:
054: public static final StyleKey BORDER_LEFT_WIDTH = StyleKey
055: .getStyleKey("border-left-width", Float.class, false, false);
056: public static final StyleKey BORDER_LEFT_STYLE = StyleKey
057: .getStyleKey("border-left-style", BorderStyle.class, false,
058: false);
059: public static final StyleKey BORDER_LEFT_COLOR = StyleKey
060: .getStyleKey("border-left-color", Color.class, false, false);
061:
062: public static final StyleKey BORDER_BOTTOM_WIDTH = StyleKey
063: .getStyleKey("border-bottom-width", Float.class, false,
064: false);
065: public static final StyleKey BORDER_BOTTOM_STYLE = StyleKey
066: .getStyleKey("border-bottom-style", BorderStyle.class,
067: false, false);
068: public static final StyleKey BORDER_BOTTOM_COLOR = StyleKey
069: .getStyleKey("border-bottom-color", Color.class, false,
070: false);
071:
072: public static final StyleKey BORDER_RIGHT_WIDTH = StyleKey
073: .getStyleKey("border-right-width", Float.class, false,
074: false);
075: public static final StyleKey BORDER_RIGHT_STYLE = StyleKey
076: .getStyleKey("border-right-style", BorderStyle.class,
077: false, false);
078: public static final StyleKey BORDER_RIGHT_COLOR = StyleKey
079: .getStyleKey("border-right-color", Color.class, false,
080: false);
081:
082: public static final StyleKey BORDER_BREAK_WIDTH = StyleKey
083: .getStyleKey("border-break-width", Float.class, false,
084: false);
085: public static final StyleKey BORDER_BREAK_STYLE = StyleKey
086: .getStyleKey("border-break-style", BorderStyle.class,
087: false, false);
088: public static final StyleKey BORDER_BREAK_COLOR = StyleKey
089: .getStyleKey("border-break-color", Color.class, false,
090: false);
091:
092: public static final StyleKey BORDER_TOP_RIGHT_RADIUS = StyleKey
093: .getStyleKey("border-top-right-radius", Dimension2D.class,
094: true, false);
095: public static final StyleKey BORDER_TOP_LEFT_RADIUS = StyleKey
096: .getStyleKey("border-top-left-radius", Dimension2D.class,
097: true, false);
098: public static final StyleKey BORDER_BOTTOM_RIGHT_RADIUS = StyleKey
099: .getStyleKey("border-bottom-right-radius",
100: Dimension2D.class, true, false);
101: public static final StyleKey BORDER_BOTTOM_LEFT_RADIUS = StyleKey
102: .getStyleKey("border-bottom-left-radius",
103: Dimension2D.class, true, false);
104:
105: public static final StyleKey BORDER_TOP_RIGHT_RADIUS_WIDTH = StyleKey
106: .getStyleKey("border-top-right-radius-width", Float.class,
107: false, false);
108: public static final StyleKey BORDER_TOP_LEFT_RADIUS_WIDTH = StyleKey
109: .getStyleKey("border-top-left-radius-width", Float.class,
110: false, false);
111: public static final StyleKey BORDER_BOTTOM_RIGHT_RADIUS_WIDTH = StyleKey
112: .getStyleKey("border-bottom-right-radius-width",
113: Float.class, false, false);
114: public static final StyleKey BORDER_BOTTOM_LEFT_RADIUS_WIDTH = StyleKey
115: .getStyleKey("border-bottom-left-radius-width",
116: Float.class, false, false);
117: public static final StyleKey BORDER_TOP_RIGHT_RADIUS_HEIGHT = StyleKey
118: .getStyleKey("border-top-right-radius-height", Float.class,
119: false, false);
120: public static final StyleKey BORDER_TOP_LEFT_RADIUS_HEIGHT = StyleKey
121: .getStyleKey("border-top-left-radius-height", Float.class,
122: false, false);
123: public static final StyleKey BORDER_BOTTOM_RIGHT_RADIUS_HEIGHT = StyleKey
124: .getStyleKey("border-bottom-right-radius-height",
125: Float.class, false, false);
126: public static final StyleKey BORDER_BOTTOM_LEFT_RADIUS_HEIGHT = StyleKey
127: .getStyleKey("border-bottom-left-radius-height",
128: Float.class, false, false);
129:
130: public static final StyleKey PADDING_LEFT = StyleKey.getStyleKey(
131: "padding-left", Float.class, false, false);
132: public static final StyleKey PADDING_TOP = StyleKey.getStyleKey(
133: "padding-top", Float.class, false, false);
134: public static final StyleKey PADDING_BOTTOM = StyleKey.getStyleKey(
135: "padding-bottom", Float.class, false, false);
136: public static final StyleKey PADDING_RIGHT = StyleKey.getStyleKey(
137: "padding-right", Float.class, false, false);
138:
139: public static final StyleKey OVERFLOW_X = StyleKey.getStyleKey(
140: "overflow-x", Boolean.class, false, false);
141: public static final StyleKey OVERFLOW_Y = StyleKey.getStyleKey(
142: "overflow-y", Boolean.class, false, false);
143:
144: public static final StyleKey BOX_SIZING = StyleKey.getStyleKey(
145: "box-sizing", BoxSizing.class, false, false);
146:
147: /**
148: * A key for the absolute position of an element.
149: * @deprecated use the POS_X and POS_Y keys instead.
150: */
151: public static final StyleKey ABSOLUTE_POS = StyleKey.getStyleKey(
152: "absolute_pos", Point2D.class, true, false);
153:
154: public static final StyleKey POS_X = StyleKey.getStyleKey("x",
155: Float.class, false, false);
156: public static final StyleKey POS_Y = StyleKey.getStyleKey("y",
157: Float.class, false, false);
158:
159: /**
160: * If this flag is set to true, the engine will try to avoid pagebreaks in this box. However, if after one break
161: * the box still doesnot fit into the page, we will start breaking the box.
162: */
163: public static final StyleKey AVOID_PAGEBREAK_INSIDE = StyleKey
164: .getStyleKey("avoid-page-break", Boolean.class);
165:
166: /**
167: * A key for the 'minimum size' of an element.
168: * This style property is not inherited from the parent band.
169: * @deprecated use the minimum-width and minimum-height style-keys instead.
170: */
171: public static final StyleKey MINIMUMSIZE = StyleKey.getStyleKey(
172: "min-size", Dimension2D.class, true, false);
173:
174: public static final StyleKey MIN_WIDTH = StyleKey.getStyleKey(
175: "min-width", Float.class, false, false);
176: public static final StyleKey MIN_HEIGHT = StyleKey.getStyleKey(
177: "min-height", Float.class, false, false);
178:
179: /**
180: * A key for the 'maximum size' of an element.
181: * This style property is not inherited from the parent band.
182: * @deprecated use the max-width and max-height style-keys instead.
183: */
184: public static final StyleKey MAXIMUMSIZE = StyleKey.getStyleKey(
185: "max-size", Dimension2D.class, true, false);
186:
187: public static final StyleKey MAX_WIDTH = StyleKey.getStyleKey(
188: "max-width", Float.class, false, false);
189: public static final StyleKey MAX_HEIGHT = StyleKey.getStyleKey(
190: "max-height", Float.class, false, false);
191:
192: /**
193: * A key for the 'preferred size' of an element.
194: * This style property is not inherited from the parent band.
195: * @deprecated use the width and height style-keys instead.
196: */
197: public static final StyleKey PREFERREDSIZE = StyleKey.getStyleKey(
198: "preferred-size", Dimension2D.class, true, false);
199:
200: public static final StyleKey WIDTH = StyleKey.getStyleKey("width",
201: Float.class, false, false);
202: public static final StyleKey HEIGHT = StyleKey.getStyleKey(
203: "height", Float.class, false, false);
204:
205: /**
206: * A key for the 'bounds' of an element.
207: * This style property is not inherited from the parent band.
208: * This style property is an internal state property and is therefore
209: * not written to the XML.
210: * @deprecated no longer used.
211: */
212: public static final StyleKey BOUNDS = StyleKey.getStyleKey(
213: "bounds", StrictBounds.class, true, false);
214:
215: /**
216: * A key for an element's 'visible' flag.
217: */
218: public static final StyleKey VISIBLE = StyleKey.getStyleKey(
219: "visible", Boolean.class, false, false);
220:
221: /**
222: * A key for the 'paint' used to color an element. For historical reasons, this key
223: * requires a color value.
224: */
225: public static final StyleKey PAINT = StyleKey.getStyleKey("paint",
226: Color.class);
227:
228: /**
229: * A key for the 'ext-paint' used to fill or draw an element. If the specified paint is
230: * not supported by the output target, the color given with the 'paint' key is used
231: * instead.
232: */
233: public static final StyleKey EXTPAINT = StyleKey.getStyleKey(
234: "ext-paint", Paint.class);
235:
236: public static final StyleKey BACKGROUND_COLOR = StyleKey
237: .getStyleKey("background-color", Color.class, false, false);
238:
239: /**
240: * A key for the 'stroke' used to draw an element. (This now only applies to shape and drawable-elements.)
241: */
242: public static final StyleKey STROKE = StyleKey.getStyleKey(
243: "stroke", Stroke.class);
244: //
245: // public static final StyleKey STROKE_STYLE = StyleKey.getStyleKey("stroke-style", String.class);
246: // public static final StyleKey STROKE_WIDTH = StyleKey.getStyleKey("stroke-width", Float.class);
247:
248: /**
249: * A key for the horizontal alignment of an element.
250: */
251: public static final StyleKey ALIGNMENT = StyleKey.getStyleKey(
252: "alignment", ElementAlignment.class);
253:
254: /**
255: * A key for the vertical alignment of an element. This is the content alignment for all elements. However, if a
256: * text-element defines a vertical-text-alignment, then this one is used instead.
257: */
258: public static final StyleKey VALIGNMENT = StyleKey.getStyleKey(
259: "valignment", ElementAlignment.class);
260:
261: /**
262: * A key for an element's 'scale' flag.
263: */
264: public static final StyleKey SCALE = StyleKey.getStyleKey("scale",
265: Boolean.class);
266:
267: /**
268: * A key for an element's 'keep aspect ratio' flag.
269: */
270: public static final StyleKey KEEP_ASPECT_RATIO = StyleKey
271: .getStyleKey("keepAspectRatio", Boolean.class);
272:
273: /**
274: * A key for the dynamic height flag for an element.
275: */
276: public static final StyleKey DYNAMIC_HEIGHT = StyleKey.getStyleKey(
277: "dynamic_height", Boolean.class);
278:
279: /**
280: * The Layout Cacheable stylekey. Set this stylekey to false, to define that the element
281: * is not cachable. This key defaults to true.
282: *
283: * @deprecated
284: */
285: public static final StyleKey ELEMENT_LAYOUT_CACHEABLE = StyleKey
286: .getStyleKey("layout-cacheable", Boolean.class);
287:
288: public static final StyleKey ANCHOR_NAME = StyleKey.getStyleKey(
289: "anchor-name", String.class, false, false);
290:
291: public static final StyleKey HREF_TARGET = StyleKey.getStyleKey(
292: "href-target", String.class, false, false);
293: public static final StyleKey HREF_TITLE = StyleKey.getStyleKey(
294: "href-title", String.class, false, false);
295:
296: /**
297: * Specifies the anchor tag's target window for opening the link.
298: */
299: public static final StyleKey HREF_WINDOW = StyleKey.getStyleKey(
300: "href-html-window", String.class);
301:
302: /**
303: * An internal flag style indicating whether the current HRef is inherited from
304: * a child.
305: *
306: * This style property is an internal state property and is therefore
307: * not written to the XML.
308: *
309: * @deprecated the HREF is no longer inheritable and therefore this key is not used anymore.
310: */
311: public static final StyleKey HREF_INHERITED = StyleKey.getStyleKey(
312: "href-inherited", Boolean.class, true, false);
313:
314: /**
315: * The StyleKey for the user defined cell data format.
316: */
317: public static final StyleKey EXCEL_WRAP_TEXT = StyleKey
318: .getStyleKey("Excel.WrapText", Boolean.class);
319:
320: /**
321: * The StyleKey for the user defined cell data format.
322: */
323: public static final StyleKey EXCEL_DATA_FORMAT_STRING = StyleKey
324: .getStyleKey("Excel.CellDataFormat", String.class, false,
325: false);
326:
327: /**
328: * A key for the 'fill-shape' style.
329: */
330: public static final StyleKey FILL_SHAPE = StyleKey.getStyleKey(
331: "fill-shape", Boolean.class);
332:
333: /**
334: * A key for the 'draw-shape' style.
335: */
336: public static final StyleKey DRAW_SHAPE = StyleKey.getStyleKey(
337: "draw-shape", Boolean.class);
338:
339: public static final StyleKey ORPHANS = StyleKey.getStyleKey(
340: "orphans", Integer.class, false, false);
341: public static final StyleKey WIDOWS = StyleKey.getStyleKey(
342: "widows", Integer.class, false, false);
343:
344: private ElementStyleKeys() {
345: }
346: }
|