Code Coverage for tapestry release 4.0.3

Clover coverage report - Code Coverage for tapestry release 4.0.3

Coverage timestamp: Fri May 5 2006 21:17:42 CDT

FRAMES NO FRAMES

file stats:	LOC:	172		Methods:	4
	NCLOC:	75		Classes:	1

Source file

Conditionals

Statements

Methods

TOTAL

PropertySelection.java

68.8%

85.7%

75%

80.6%

1		// Copyright 2004, 2005 The Apache Software Foundation
2		//
3		// Licensed under the Apache License, Version 2.0 (the "License");
4		// you may not use this file except in compliance with the License.
5		// You may obtain a copy of the License at
6		//
7		// http://www.apache.org/licenses/LICENSE-2.0
8		//
9		// Unless required by applicable law or agreed to in writing, software
10		// distributed under the License is distributed on an "AS IS" BASIS,
11		// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12		// See the License for the specific language governing permissions and
13		// limitations under the License.
14
15		package org.apache.tapestry.form;
16
17		import org.apache.tapestry.IMarkupWriter;
18		import org.apache.tapestry.IRequestCycle;
19		import org.apache.tapestry.Tapestry;
20		import org.apache.tapestry.valid.ValidatorException;
21
22		/**
23		* A component used to render a drop-down list of options that the user may select. [ <a
24		* href="../../../../../ComponentReference/PropertySelection.html">Component Reference </a>]
25		* <p>
26		* Earlier versions of PropertySelection (through release 2.2) were more flexible, they included a
27		* <b>renderer </b> property that controlled how the selection was rendered. Ultimately, this proved
28		* of little value and this portion of functionality was deprecated in 2.3 and will be removed in
29		* 2.3.
30		* <p>
31		* Typically, the values available to be selected are defined using an
32		* {@link org.apache.commons.lang.enum.Enum}. A PropertySelection is dependent on an
33		* {@link IPropertySelectionModel} to provide the list of possible values.
34		* <p>
35		* Often, this is used to select a particular {@link org.apache.commons.lang.enum.Enum} to assign to
36		* a property; the {@link EnumPropertySelectionModel} class simplifies this.
37		* <p>
38		* Often, a drop-down list will contain an initial option that serves both as a label and to represent
39		* that nothing is selected. This can behavior can easily be achieved by decorating an existing
40		* {@link IPropertySelectionModel} with a {@link LabeledPropertySelectionModel}.
41		* <p>
42		* As of 4.0, this component can be validated.
43		*
44		* @author Howard Lewis Ship
45		* @author Paul Ferraro
46		*/
47		public abstract class PropertySelection extends AbstractFormComponent implements ValidatableField
48		{
49		/**
50		* @see org.apache.tapestry.form.AbstractFormComponent#renderFormComponent(org.apache.tapestry.IMarkupWriter, org.apache.tapestry.IRequestCycle)
51		*/
52	9	protected void renderFormComponent(IMarkupWriter writer, IRequestCycle cycle)
53		{
54	9	renderDelegatePrefix(writer, cycle);
55
56	9	writer.begin("select");
57	9	writer.attribute("name", getName());
58
59	9	if (isDisabled())
60	0	writer.attribute("disabled", "disabled");
61
62	9	if (getSubmitOnChange())
63	0	writer.attribute("onchange", "javascript: this.form.events.submit();");
64
65	9	renderIdAttribute(writer, cycle);
66
67	9	renderDelegateAttributes(writer, cycle);
68
69	9	getValidatableFieldSupport().renderContributions(this, writer, cycle);
70
71		// Apply informal attributes.
72	9	renderInformalParameters(writer, cycle);
73
74	9	writer.println();
75
76	9	IPropertySelectionModel model = getModel();
77
78	9	if (model == null)
79	0	throw Tapestry.createRequiredParameterException(this, "model");
80
81	9	int count = model.getOptionCount();
82	9	boolean foundSelected = false;
83	9	Object value = getValue();
84
85	9	for (int i = 0; i < count; i++)
86		{
87	63	Object option = model.getOption(i);
88
89	63	writer.begin("option");
90	63	writer.attribute("value", model.getValue(i));
91
92	63	if (!foundSelected && isEqual(option, value))
93		{
94	9	writer.attribute("selected", "selected");
95
96	9	foundSelected = true;
97		}
98
99	63	writer.print(model.getLabel(i));
100
101	63	writer.end();
102
103	63	writer.println();
104		}
105
106	9	writer.end(); // <select>
107
108	9	renderDelegateSuffix(writer, cycle);
109		}
110
111		/**
112		* @see org.apache.tapestry.form.AbstractFormComponent#rewindFormComponent(org.apache.tapestry.IMarkupWriter, org.apache.tapestry.IRequestCycle)
113		*/
114	9	protected void rewindFormComponent(IMarkupWriter writer, IRequestCycle cycle)
115		{
116	9	String value = cycle.getParameter(getName());
117
118	9	Object object = (value == null) ? null : getModel().translateValue(value);
119
120	9	try
121		{
122	9	getValidatableFieldSupport().validate(this, writer, cycle, object);
123
124	9	setValue(object);
125		}
126		catch (ValidatorException e)
127		{
128	0	getForm().getDelegate().record(e);
129		}
130		}
131
132	27	private boolean isEqual(Object left, Object right)
133		{
134		// Both null, or same object, then are equal
135
136	27	if (left == right)
137	9	return true;
138
139		// If one is null, the other isn't, then not equal.
140
141	18	if (left == null \|\| right == null)
142	0	return false;
143
144		// Both non-null; use standard comparison.
145
146	18	return left.equals(right);
147		}
148
149		public abstract IPropertySelectionModel getModel();
150
151		/** @since 2.2 * */
152		public abstract boolean getSubmitOnChange();
153
154		/** @since 2.2 * */
155		public abstract Object getValue();
156
157		/** @since 2.2 * */
158		public abstract void setValue(Object value);
159
160		/**
161		* Injected.
162		*/
163		public abstract ValidatableFieldSupport getValidatableFieldSupport();
164
165		/**
166		* @see org.apache.tapestry.form.AbstractFormComponent#isRequired()
167		*/
168	0	public boolean isRequired()
169		{
170	0	return getValidatableFieldSupport().isRequired(this);
171		}
172		}