01: /**
02: * ===========================================
03: * JFreeReport : a free Java reporting library
04: * ===========================================
05: *
06: * Project Info: http://reporting.pentaho.org/
07: *
08: * (C) Copyright 2001-2007, by Object Refinery Ltd, Pentaho Corporation and Contributors.
09: *
10: * This library is free software; you can redistribute it and/or modify it under the terms
11: * of the GNU Lesser General Public License as published by the Free Software Foundation;
12: * either 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, but WITHOUT ANY WARRANTY;
15: * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16: * See the GNU Lesser General Public License for more details.
17: *
18: * You should have received a copy of the GNU Lesser General Public License along with this
19: * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20: * Boston, MA 02111-1307, USA.
21: *
22: * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
23: * in the United States and other countries.]
24: *
25: * ------------
26: * HideElementByNameFunction.java
27: * ------------
28: * (C) Copyright 2001-2007, by Object Refinery Ltd, Pentaho Corporation and Contributors.
29: */package org.jfree.report.function;
30:
31: import org.jfree.report.Band;
32: import org.jfree.report.Element;
33: import org.jfree.util.ObjectUtilities;
34:
35: /**
36: * This function hides all elements with a given name, as long as the defined <code>field</code> does <b>not</b> contain
37: * the element name.
38: *
39: * @author Thomas Morgner
40: */
41: public class HideElementByNameFunction extends
42: AbstractElementFormatFunction {
43: /**
44: * The name of the data-row column that is checked for null-values.
45: */
46: private String field;
47:
48: /**
49: * Default Constructor.
50: */
51: public HideElementByNameFunction() {
52: }
53:
54: /**
55: * Returns the field used by the function. The field name corresponds to a column name in the report's data-row.
56: *
57: * @return The field name.
58: */
59: public String getField() {
60: return field;
61: }
62:
63: /**
64: * Defines the field name for the function. The field name corresponds to a column name in the report's data-row.
65: *
66: * @param field the field name.
67: */
68: public void setField(final String field) {
69: this .field = field;
70: }
71:
72: /**
73: * Applies the computed visiblity to all child elements of the given band.
74: *
75: * @param b the visibility.
76: */
77: protected void processRootBand(final Band b) {
78: final boolean visible = ObjectUtilities.equal(getElement(),
79: getDataRow().get(getField()));
80: final Element[] elements = FunctionUtilities.findAllElements(b,
81: getElement());
82: for (int i = 0; i < elements.length; i++) {
83: final Element element = elements[i];
84: element.setVisible(visible);
85: }
86: }
87: }
|