Java > Open Source Codes > net > sf > jasperreports > engine > JRStyle


1 /*
2  * ============================================================================
3  * GNU Lesser General Public License
4  * ============================================================================
5  *
6  * JasperReports - Free Java report-generating library.
7  * Copyright (C) 2001-2006 JasperSoft Corporation http://www.jaspersoft.com
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 2.1 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with this library; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
22  *
23  * JasperSoft Corporation
24  * 303 Second Street, Suite 450 North
25  * San Francisco, CA 94107
26  * http://www.jaspersoft.com
27  */
28 package net.sf.jasperreports.engine;
29
30 import java.awt.Color ;
31
32 /**
33  * @author Ionut Nedelcu (ionutned@users.sourceforge.net)
34  * @version $Id: JRStyle.java 1229 2006-04-19 13:27:35 +0300 (Wed, 19 Apr 2006) teodord $
35  */
36 public interface JRStyle extends JRStyleContainer
37 {
38     /**
39      * Gets the style unique name.
40      */
41     public String getName();
42
43     /**
44      * Gets a flag that specifies if this is the default report style.
45      */
46     public boolean isDefault();
47
48     /**
49      * Returns the element transparency mode.
50      * The default value depends on the type of the report element. Graphic elements like rectangles and lines are
51      * opaque by default, but the images are transparent. Both static texts and text fields are transparent
52      * by default, and so are the subreport elements.
53      * @return MODE_OPAQUE or MODE_TRANSPARENT
54      */
55     public Byte getMode();
56
57     public Byte getOwnMode();
58
59     public Color getForecolor();
60
61     public Color getOwnForecolor();
62
63     public Color getBackcolor();
64
65     public Color getOwnBackcolor();
66
67     /**
68      * Indicates the pen type used for this element.
69      * @return one of the pen constants in this class
70      */
71     public Byte getPen();
72
73     public Byte getOwnPen();
74
75     /**
76      * Indicates the fill type used for this element.
77      * @return one of the pen constants in this class
78      */
79     public Byte getFill();
80
81     public Byte getOwnFill();
82
83     /**
84      * Indicates the corner radius for rectangles with round corners. The default is 0.
85      */
86     public Integer getRadius();
87
88     public Integer getOwnRadius();
89
90     /**
91      * Gets the image scale type.
92      * @return one of the scale constants in this class
93      */
94     public Byte getScaleImage();
95
96     public Byte getOwnScaleImage();
97
98     /**
99      * Gets the horizontal alignment of the element.
100      * @return one of the alignment values defined in {@link JRAlignment}
101      */
102     public Byte getHorizontalAlignment();
103
104     public Byte getOwnHorizontalAlignment();
105
106     /**
107      * Gets the vertical alignment of the element.
108      * @return one of the alignment values defined in {@link JRAlignment}
109      */
110     public Byte getVerticalAlignment();
111
112     public Byte getOwnVerticalAlignment();
113
114     /**
115      * Gets the default border pen size (can be overwritten by individual settings).
116      */
117     public Byte getBorder();
118
119     public Byte getOwnBorder();
120
121     /**
122      * Gets the default border color (can be overwritten by individual settings).
123      */
124     public Color getBorderColor();
125
126     public Color getOwnBorderColor();
127
128     /**
129      * Gets the default padding in pixels (can be overwritten by individual settings).
130      */
131     public Integer getPadding();
132
133     public Integer getOwnPadding();
134
135     /**
136      * Gets the top border pen size.
137      */
138     public Byte getTopBorder();
139
140
141     /**
142      * Gets the top border pen size (if the default value was overwritten).
143      */
144     public Byte getOwnTopBorder();
145
146
147     /**
148      * Gets the top border color.
149      */
150     public Color getTopBorderColor();
151
152
153     /**
154      * Gets the top border color (if the default value was overwritten).
155      */
156     public Color getOwnTopBorderColor();
157
158
159     /**
160      *
161      */
162     public Integer getTopPadding();
163
164
165     /**
166      *
167      */
168     public Integer getOwnTopPadding();
169
170
171     /**
172      *
173      */
174     public Byte getLeftBorder();
175
176
177     /**
178      *
179      */
180     public Byte getOwnLeftBorder();
181
182
183     /**
184      *
185      */
186     public Color getLeftBorderColor();
187
188
189     /**
190      *
191      */
192     public Color getOwnLeftBorderColor();
193
194
195     /**
196      *
197      */
198     public Integer getLeftPadding();
199
200
201     /**
202      *
203      */
204     public Integer getOwnLeftPadding();
205
206
207     /**
208      *
209      */
210     public Byte getBottomBorder();
211
212
213     /**
214      *
215      */
216     public Byte getOwnBottomBorder();
217
218
219     /**
220      *
221      */
222     public Color getBottomBorderColor();
223
224
225     /**
226      *
227      */
228     public Color getOwnBottomBorderColor();
229
230
231     /**
232      *
233      */
234     public Integer getBottomPadding();
235
236
237     /**
238      *
239      */
240     public Integer getOwnBottomPadding();
241
242
243     /**
244      *
245      */
246     public Byte getRightBorder();
247
248
249     /**
250      *
251      */
252     public Byte getOwnRightBorder();
253
254
255     /**
256      *
257      */
258     public Color getRightBorderColor();
259
260
261     /**
262      *
263      */
264     public Color getOwnRightBorderColor();
265
266
267     /**
268      *
269      */
270     public Integer getRightPadding();
271
272
273     /**
274      *
275      */
276     public Integer getOwnRightPadding();
277
278
279     /**
280      * Gets the text rotation.
281      * @return a value representing one of the rotation constants in this class
282      */
283     public Byte getRotation();
284
285     public Byte getOwnRotation();
286
287     /**
288      * Gets the line spacing.
289      * @return a value representing one of the line spacing constants in this class
290      */
291     public Byte getLineSpacing();
292
293     public Byte getOwnLineSpacing();
294
295     /**
296      * Returns true if the text can contain style tags.
297      */
298     public Boolean isStyledText();
299
300     public Boolean isOwnStyledText();
301
302     /**
303      *
304      */
305     public String getFontName();
306
307     /**
308      *
309      */
310     public String getOwnFontName();
311
312     /**
313      *
314      */
315     public Boolean isBold();
316
317     /**
318      *
319      */
320     public Boolean isOwnBold();
321
322     /**
323      *
324      */
325     public Boolean isItalic();
326
327     /**
328      *
329      */
330     public Boolean isOwnItalic();
331
332     /**
333      *
334      */
335     public Boolean isUnderline();
336
337     /**
338      *
339      */
340     public Boolean isOwnUnderline();
341
342     /**
343      *
344      */
345     public Boolean isStrikeThrough();
346
347     /**
348      *
349      */
350     public Boolean isOwnStrikeThrough();
351
352     /**
353      *
354      */
355     public Integer getFontSize();
356
357     /**
358      *
359      */
360     public Integer getOwnFontSize();
361
362     /**
363      *
364      */
365     public String getPdfFontName();
366
367     /**
368      *
369      */
370     public String getOwnPdfFontName();
371
372     /**
373      *
374      */
375     public String getPdfEncoding();
376
377     /**
378      *
379      */
380     public String getOwnPdfEncoding();
381
382     /**
383      *
384      */
385     public Boolean isPdfEmbedded();
386
387     /**
388      *
389      */
390     public Boolean isOwnPdfEmbedded();
391
392     /**
393      * Gets the pattern used for this text field. The pattern will be used in a <tt>SimpleDateFormat</tt> for dates
394      * and a <tt>DecimalFormat</tt> for numeric text fields. The pattern format must follow one of these two classes
395      * formatting rules, as specified in the JDK API docs.
396      * @return a string containing the pattern.
397      */
398     public String getPattern();
399
400     public String getOwnPattern();
401
402     /**
403      *
404      */
405     public Boolean isBlankWhenNull();
406
407     /**
408      *
409      */
410     public Boolean isOwnBlankWhenNull();
411
412     /**
413      *
414      */
415     public void setForecolor(Color forecolor);
416
417     /**
418      *
419      */
420     public void setBackcolor(Color backcolor);
421
422     /**
423      *
424      */
425     public void setMode(byte mode);
426
427     /**
428      *
429      */
430     public void setMode(Byte mode);
431
432     /**
433      *
434      */
435     public void setPen(byte pen);
436
437     /**
438      *
439      */
440     public void setPen(Byte pen);
441
442     /**
443      *
444      */
445     public void setFill(byte fill);
446
447     /**
448      *
449      */
450     public void setFill(Byte fill);
451
452     /**
453      *
454      */
455     public void setRadius(int radius);
456
457     /**
458      *
459      */
460     public void setRadius(Integer radius);
461
462     /**
463      *
464      */
465     public void setScaleImage(byte scaleImage);
466
467     /**
468      *
469      */
470     public void setScaleImage(Byte scaleImage);
471
472     /**
473      *
474      */
475     public void setHorizontalAlignment(byte horizontalAlignment);
476
477     /**
478      *
479      */
480     public void setHorizontalAlignment(Byte horizontalAlignment);
481
482     /**
483      *
484      */
485     public void setVerticalAlignment(byte verticalAlignment);
486
487     /**
488      *
489      */
490     public void setVerticalAlignment(Byte verticalAlignment);
491
492     /**
493      *
494      */
495     public void setBorder(byte border);
496
497     /**
498      *
499      */
500     public void setBorder(Byte border);
501
502     /**
503      *
504      */
505     public void setBorderColor(Color borderColor);
506
507     /**
508      *
509      */
510     public void setPadding(int padding);
511
512     /**
513      *
514      */
515     public void setPadding(Integer padding);
516
517     /**
518      *
519      */
520     public void setTopBorder(byte topBorder);
521
522     /**
523      *
524      */
525     public void setTopBorder(Byte topBorder);
526
527     /**
528      *
529      */
530     public void setTopBorderColor(Color topBorderColor);
531
532     /**
533      *
534      */
535     public void setTopPadding(int topPadding);
536
537     /**
538      *
539      */
540     public void setTopPadding(Integer topPadding);
541
542     /**
543      *
544      */
545     public void setLeftBorder(byte leftBorder);
546
547     /**
548      *
549      */
550     public void setLeftBorder(Byte leftBorder);
551
552     /**
553      *
554      */
555     public void setLeftBorderColor(Color leftBorderColor);
556
557     /**
558      *
559      */
560     public void setLeftPadding(int leftPadding);
561
562     /**
563      *
564      */
565     public void setLeftPadding(Integer leftPadding);
566
567     /**
568      *
569      */
570     public void setBottomBorder(byte bottomBorder);
571
572     /**
573      *
574      */
575     public void setBottomBorder(Byte bottomBorder);
576
577     /**
578      *
579      */
580     public void setBottomBorderColor(Color bottomBorderColor);
581
582     /**
583      *
584      */
585     public void setBottomPadding(int bottomPadding);
586
587     /**
588      *
589      */
590     public void setBottomPadding(Integer bottomPadding);
591
592     /**
593      *
594      */
595     public void setRightBorder(byte rightBorder);
596
597     /**
598      *
599      */
600     public void setRightBorder(Byte rightBorder);
601
602     /**
603      *
604      */
605     public void setRightBorderColor(Color rightBorderColor);
606
607     /**
608      *
609      */
610     public void setRightPadding(int rightPadding);
611
612     /**
613      *
614      */
615     public void setRightPadding(Integer rightPadding);
616
617     /**
618      *
619      */
620     public void setRotation(byte rotation);
621
622     /**
623      *
624      */
625     public void setRotation(Byte rotation);
626
627     /**
628      *
629      */
630     public void setFontName(String fontName);
631
632     /**
633      *
634      */
635     public void setBold(boolean bold);
636
637     /**
638      *
639      */
640     public void setBold(Boolean bold);
641
642     /**
643      *
644      */
645     public void setItalic(boolean italic);
646
647     /**
648      *
649      */
650     public void setItalic(Boolean italic);
651
652     /**
653      *
654      */
655     public void setPdfEmbedded(boolean pdfEmbedded);
656
657     /**
658      *
659      */
660     public void setPdfEmbedded(Boolean pdfEmbedded);
661
662     /**
663      *
664      */
665     public void setStrikeThrough(boolean strikeThrough);
666
667     /**
668      *
669      */
670     public void setStrikeThrough(Boolean strikeThrough);
671
672     /**
673      *
674      */
675     public void setStyledText(boolean styledText);
676
677     /**
678      *
679      */
680     public void setStyledText(Boolean styledText);
681
682     /**
683      *
684      */
685     public void setUnderline(boolean underline);
686
687     /**
688      *
689      */
690     public void setUnderline(Boolean underline);
691
692     /**
693      *
694      */
695     public void setLineSpacing(byte lineSpacing);
696
697     /**
698      *
699      */
700     public void setLineSpacing(Byte lineSpacing);
701
702     /**
703      *
704      */
705     public void setPattern(String pattern);
706
707     /**
708      *
709      */
710     public void setBlankWhenNull(boolean isBlankWhenNull);
711
712     /**
713      *
714      */
715     public void setBlankWhenNull(Boolean isBlankWhenNull);
716
717     /**
718      *
719      */
720     public void setPdfEncoding(String pdfEncoding);
721
722     /**
723      *
724      */
725     public void setPdfFontName(String pdfFontName);
726
727     /**
728      *
729      */
730     public void setFontSize(int fontSize);
731
732     /**
733      *
734      */
735     public void setFontSize(Integer fontSize);
736
737     /**
738      *
739      */
740     public JRConditionalStyle[] getConditionalStyles();
741 }
742

A to Z: JavaDoc & Examples

---

Daily Java News & Articles

---

Open Source Projects

---

Open Source Codes

---

Free Computer Books

---

Remove Frame

---

Popular Tags