/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.wicket.markup.html.form;
import java.util.List;
import org.apache.wicket.RequestContext;
import org.apache.wicket.markup.ComponentTag;
import org.apache.wicket.markup.MarkupStream;
import org.apache.wicket.model.IModel;
import org.apache.wicket.protocol.http.portlet.PortletRequestContext;
import org.apache.wicket.util.string.AppendingStringBuffer;
import org.apache.wicket.util.string.Strings;
import org.apache.wicket.util.convert.IConverter;
import org.apache.wicket.version.undo.Change;
/**
* A choice subclass that shows choices in radio style.
* <p>
* Java:
*
* <pre>
* List SITES = Arrays.asList(new String[] { "The Server Side", "Java Lobby", "Java.Net" });
* // Add a radio choice component that uses Input's 'site' property to designate the
* // current selection, and that uses the SITES list for the available options.
* form.add(new RadioChoice("site", SITES));
* </pre>
*
* HTML:
*
* <pre>
* <span valign="top" wicket:id="site">
* <input type="radio">site 1</input>
* <input type="radio">site 2</input>
* </span>
* </pre>
*
* </p>
*
* <p>
* You can can extend this class and override method wantOnSelectionChangedNotifications() to force
* server roundtrips on each selection change.
* </p>
*
* @author Jonathan Locke
* @author Igor Vaynberg (ivaynberg)
*
* @param <T>
* The model object type
*/
public class RadioChoice<T> extends AbstractSingleSelectChoice<T> implements IOnChangeListener
{
private static final long serialVersionUID = 1L;
/** suffix change record. */
private class SuffixChange extends Change
{
private static final long serialVersionUID = 1L;
final String prevSuffix;
SuffixChange(String prevSuffix)
{
this.prevSuffix = prevSuffix;
}
/**
* @see org.apache.wicket.version.undo.Change#undo()
*/
@Override
public void undo()
{
setSuffix(prevSuffix);
}
/**
* @see java.lang.Object#toString()
*/
@Override
public String toString()
{
return "SuffixChange[component: " + getPath() + ", suffix: " + prevSuffix + "]";
}
}
/**
* Prefix change record.
*/
private class PrefixChange extends Change
{
private static final long serialVersionUID = 1L;
private final String prevPrefix;
/**
* Construct.
*
* @param prevSuffix
*/
PrefixChange(String prevSuffix)
{
prevPrefix = prevSuffix;
}
/**
* @see org.apache.wicket.version.undo.Change#undo()
*/
@Override
public void undo()
{
setPrefix(prevPrefix);
}
/**
* @see java.lang.Object#toString()
*/
@Override
public String toString()
{
return "PrefixChange[component: " + getPath() + ", prefix: " + prevPrefix + "]";
}
}
private String prefix = "";
private String suffix = "<br />\n";
/**
* Constructor
*
* @param id
* See Component
* @see org.apache.wicket.Component#Component(String)
* @see org.apache.wicket.markup.html.form.AbstractChoice#AbstractChoice(String)
*/
public RadioChoice(final String id)
{
super(id);
}
/**
* Constructor
*
* @param id
* See Component
* @param choices
* The collection of choices in the radio choice
* @see org.apache.wicket.Component#Component(String)
* @see org.apache.wicket.markup.html.form.AbstractChoice#AbstractChoice(String, List)
*/
public RadioChoice(final String id, final List<T> choices)
{
super(id, choices);
}
/**
* Constructor
*
* @param id
* See Component
* @param renderer
* The rendering engine
* @param choices
* The collection of choices in the radio choice
* @see org.apache.wicket.Component#Component(String)
* @see org.apache.wicket.markup.html.form.AbstractChoice#AbstractChoice(String,
* List,IChoiceRenderer)
*/
public RadioChoice(final String id, final List<T> choices, final IChoiceRenderer<T> renderer)
{
super(id, choices, renderer);
}
/**
* Constructor
*
* @param id
* See Component
* @param model
* See Component
* @param choices
* The collection of choices in the radio choice
* @see org.apache.wicket.Component#Component(String, IModel)
* @see org.apache.wicket.markup.html.form.AbstractChoice#AbstractChoice(String, IModel, List)
*/
public RadioChoice(final String id, IModel<T> model, final List<T> choices)
{
super(id, model, choices);
}
/**
* Constructor
*
* @param id
* See Component
* @param model
* See Component
* @param choices
* The collection of choices in the radio choice
* @param renderer
* The rendering engine
* @see org.apache.wicket.Component#Component(String, IModel)
* @see org.apache.wicket.markup.html.form.AbstractChoice#AbstractChoice(String, IModel,
* List,IChoiceRenderer)
*/
public RadioChoice(final String id, IModel<T> model, final List<T> choices,
final IChoiceRenderer<T> renderer)
{
super(id, model, choices, renderer);
}
/**
* Constructor
*
* @param id
* See Component
* @param choices
* The collection of choices in the radio choice
* @see org.apache.wicket.Component#Component(String)
* @see org.apache.wicket.markup.html.form.AbstractChoice#AbstractChoice(String, IModel)
*/
public RadioChoice(String id, IModel<List< ? extends T>> choices)
{
super(id, choices);
}
/**
* Constructor
*
* @param id
* See Component
* @param model
* The model that is updated with changes in this component. See Component
* @param choices
* The collection of choices in the radio choice
* @see org.apache.wicket.markup.html.form.AbstractChoice#AbstractChoice(String, IModel,IModel)
* @see org.apache.wicket.Component#Component(String, IModel)
*/
public RadioChoice(String id, IModel<T> model, IModel<List< ? extends T>> choices)
{
super(id, model, choices);
}
/**
* Constructor
*
* @param id
* See Component
* @param choices
* The collection of choices in the radio choice
* @param renderer
* The rendering engine
* @see org.apache.wicket.markup.html.form.AbstractChoice#AbstractChoice(String,
* IModel,IChoiceRenderer)
* @see org.apache.wicket.Component#Component(String)
*/
public RadioChoice(String id, IModel<List< ? extends T>> choices, IChoiceRenderer<T> renderer)
{
super(id, choices, renderer);
}
/**
* Constructor
*
* @param id
* See Component
* @param model
* The model that is updated with changes in this component. See Component
* @param choices
* The collection of choices in the radio choice
* @param renderer
* The rendering engine
* @see org.apache.wicket.Component#Component(String, IModel)
* @see org.apache.wicket.markup.html.form.AbstractChoice#AbstractChoice(String, IModel,
* IModel,IChoiceRenderer)
*/
public RadioChoice(String id, IModel<T> model, IModel<List< ? extends T>> choices,
IChoiceRenderer<T> renderer)
{
super(id, model, choices, renderer);
}
/**
* @see org.apache.wicket.markup.html.form.FormComponent#onComponentTag(org.apache.wicket.markup.ComponentTag)
*/
@Override
protected void onComponentTag(ComponentTag tag)
{
super.onComponentTag(tag);
// since this component cannot be attached to input tag the name
// variable is illegal
tag.remove("name");
}
/**
* @see org.apache.wicket.markup.html.form.IOnChangeListener#onSelectionChanged()
*/
public void onSelectionChanged()
{
convertInput();
updateModel();
onSelectionChanged(getModelObject());
}
/**
* Template method that can be overridden by clients that implement IOnChangeListener to be
* notified by onChange events of a select element. This method does nothing by default.
* <p>
* Called when a option is selected of a dropdown list that wants to be notified of this event.
* This method is to be implemented by clients that want to be notified of selection events.
*
* @param newSelection
* The newly selected object of the backing model NOTE this is the same as you would
* get by calling getModelObject() if the new selection were current
*/
protected void onSelectionChanged(Object newSelection)
{
}
/**
* Whether this component's onSelectionChanged event handler should called using javascript if
* the selection changes. If true, a roundtrip will be generated with each selection change,
* resulting in the model being updated (of just this component) and onSelectionChanged being
* called. This method returns false by default.
*
* @return True if this component's onSelectionChanged event handler should called using
* javascript if the selection changes
*/
protected boolean wantOnSelectionChangedNotifications()
{
return false;
}
/**
* @see org.apache.wicket.MarkupContainer#getStatelessHint()
*/
@Override
protected boolean getStatelessHint()
{
if (wantOnSelectionChangedNotifications())
{
return false;
}
return super.getStatelessHint();
}
/**
* @return Prefix to use before choice
*/
public String getPrefix()
{
return prefix;
}
/**
* @param prefix
* Prefix to use before choice
* @return this
*/
public final RadioChoice<T> setPrefix(String prefix)
{
// Tell the page that this component's prefix was changed
addStateChange(new PrefixChange(this.prefix));
this.prefix = prefix;
return this;
}
/**
* @return Separator to use between radio options
*/
public String getSuffix()
{
return suffix;
}
/**
* @param suffix
* Separator to use between radio options
* @return this
*/
public final RadioChoice<T> setSuffix(String suffix)
{
// Tell the page that this component's suffix was changed
addStateChange(new SuffixChange(this.suffix));
this.suffix = suffix;
return this;
}
/**
* @see org.apache.wicket.Component#onComponentTagBody(MarkupStream, ComponentTag)
*/
@Override
protected final void onComponentTagBody(final MarkupStream markupStream,
final ComponentTag openTag)
{
// Iterate through choices
final List< ? extends T> choices = getChoices();
// Buffer to hold generated body
final AppendingStringBuffer buffer = new AppendingStringBuffer((choices.size() + 1) * 70);
// The selected value
final String selected = getValue();
// Loop through choices
for (int index = 0; index < choices.size(); index++)
{
// Get next choice
final T choice = choices.get(index);
T displayValue = (T) getChoiceRenderer().getDisplayValue(choice);
Class<T> objectClass = (Class<T>) (displayValue == null ? null : displayValue.getClass());
// Get label for choice
String label = "";
if (objectClass != null && objectClass != String.class)
{
final IConverter<T> converter = getConverter(objectClass);
if(!converter.getClass().isAssignableFrom(objectClass))
throw new IllegalArgumentException("converter can not convert " + objectClass.getName() + " to string");
label = converter.convertToString(displayValue, getLocale());
}
else if (displayValue != null)
{
label = displayValue.toString();
}
// If there is a display value for the choice, then we know that the
// choice is automatic in some way. If label is /null/ then we know
// that the choice is a manually created radio tag at some random
// location in the page markup!
if (label != null)
{
// Append option suffix
buffer.append(getPrefix());
String id = getChoiceRenderer().getIdValue(choice, index);
final String idAttr = getInputName() + "_" + id;
// Add radio tag
buffer.append("<input name=\"")
.append(getInputName())
.append("\"")
.append(" type=\"radio\"")
.append((isSelected(choice, index, selected) ? " checked=\"checked\"" : ""))
.append((isEnabled() ? "" : " disabled=\"disabled\""))
.append(" value=\"")
.append(id)
.append("\" id=\"")
.append(idAttr)
.append("\"");
// Should a roundtrip be made (have onSelectionChanged called)
// when the option is clicked?
if (wantOnSelectionChangedNotifications())
{
CharSequence url = urlFor(IOnChangeListener.INTERFACE);
Form form = (Form)findParent(Form.class);
if (form != null)
{
RequestContext rc = RequestContext.get();
if (rc.isPortletRequest())
{
// restore url back to real wicket path as its going to be interpreted
// by the form itself
url = ((PortletRequestContext)rc).getLastEncodedPath();
}
buffer.append(" onclick=\"").append(form.getJsForInterfaceUrl(url)).append(
";\"");
}
else
{
// TODO: following doesn't work with portlets, should be posted to a dynamic
// hidden form
// with an ActionURL or something
// NOTE: do not encode the url as that would give
// invalid JavaScript
buffer.append(" onclick=\"window.location.href='")
.append(url)
.append(
(url.toString().indexOf('?') > -1 ? "&" : "?") + getInputName())
.append("=")
.append(id)
.append("';\"");
}
}
buffer.append("/>");
// Add label for radio button
String display = label;
if (localizeDisplayValues())
{
display = getLocalizer().getString(label, this, label);
}
CharSequence escaped = Strings.escapeMarkup(display, false, true);
buffer.append("<label for=\"").append(idAttr).append("\">").append(escaped).append(
"</label>");
// Append option suffix
buffer.append(getSuffix());
}
}
// Replace body
replaceComponentTagBody(markupStream, openTag, buffer);
}
}