/*
* {{{ header & license
* Copyright (c) 2004, 2005 Torbj�rn Gannholm
* Copyright (c) 2007 Sean Bright
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2.1
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
* }}}
*/
package org.xhtmlrenderer.simple.extend;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.Map;
import javax.swing.AbstractButton;
import javax.swing.ButtonGroup;
import javax.swing.JComponent;
import javax.swing.JRadioButton;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.Text;
import org.xhtmlrenderer.extend.UserAgentCallback;
import org.xhtmlrenderer.layout.LayoutContext;
import org.xhtmlrenderer.render.BlockBox;
import org.xhtmlrenderer.simple.extend.form.FormField;
import org.xhtmlrenderer.simple.extend.form.FormFieldFactory;
import org.xhtmlrenderer.util.XRLog;
/**
* Represents a form object
*
* @author Torbj�rn Gannholm
* @author Sean Bright
*/
public class XhtmlForm {
private static final String FS_DEFAULT_GROUP = "__fs_default_group_";
private static int _defaultGroupCount = 1;
private UserAgentCallback _userAgentCallback;
private Map _componentCache;
private Map _buttonGroups;
private Element _parentFormElement;
private FormSubmissionListener _formSubmissionListener;
public XhtmlForm(UserAgentCallback uac, Element e, FormSubmissionListener fsListener) {
_userAgentCallback = uac;
_buttonGroups = new HashMap();
_componentCache = new LinkedHashMap();
_parentFormElement = e;
_formSubmissionListener = fsListener;
}
public XhtmlForm(UserAgentCallback uac, Element e) {
this(uac, e, new DefaultFormSubmissionListener());
}
public UserAgentCallback getUserAgentCallback() {
return _userAgentCallback;
}
public void addButtonToGroup(String groupName, AbstractButton button) {
if (groupName == null) {
groupName = createNewDefaultGroupName();
}
ButtonGroupWrapper group = (ButtonGroupWrapper) _buttonGroups.get(groupName);
if (group == null) {
group = new ButtonGroupWrapper();
_buttonGroups.put(groupName, group);
}
group.add(button);
}
private static String createNewDefaultGroupName() {
return FS_DEFAULT_GROUP + ++_defaultGroupCount;
}
private static boolean isFormField(Element e) {
String nodeName = e.getNodeName();
if (nodeName.equals("input") || nodeName.equals("select") || nodeName.equals("textarea")) {
return true;
}
return false;
}
public FormField addComponent(Element e, LayoutContext context, BlockBox box) {
FormField field = null;
if (_componentCache.containsKey(e)) {
field = (FormField) _componentCache.get(e);
} else {
if (!isFormField(e)) {
return null;
}
field = FormFieldFactory.create(this, context, box);
if (field == null) {
XRLog.layout("Unknown field type: " + e.getNodeName());
return null;
}
_componentCache.put(e, field);
}
return field;
}
public void reset() {
Iterator buttonGroups = _buttonGroups.values().iterator();
while (buttonGroups.hasNext()) {
((ButtonGroupWrapper) buttonGroups.next()).clearSelection();
}
Iterator fields = _componentCache.values().iterator();
while (fields.hasNext()) {
((FormField) fields.next()).reset();
}
}
public void submit(JComponent source) {
// If we don't have a <form> to tell us what to do, don't
// do anything.
if (_parentFormElement == null) {
return;
}
StringBuffer data = new StringBuffer();
String action = _parentFormElement.getAttribute("action");
data.append(action).append("?");
Iterator fields = _componentCache.entrySet().iterator();
boolean first=true;
while (fields.hasNext()) {
Map.Entry entry = (Map.Entry) fields.next();
FormField field = (FormField) entry.getValue();
if (field.includeInSubmission(source)) {
String [] dataStrings = field.getFormDataStrings();
for (int i = 0; i < dataStrings.length; i++) {
if (!first) {
data.append('&');
}
data.append(dataStrings[i]);
first=false;
}
}
}
if(_formSubmissionListener !=null) _formSubmissionListener.submit(data.toString());
}
public static String collectText(Element e) {
StringBuffer result = new StringBuffer();
Node node = e.getFirstChild();
if (node != null) {
do {
short nodeType = node.getNodeType();
if (nodeType == Node.TEXT_NODE || nodeType == Node.CDATA_SECTION_NODE) {
Text text = (Text) node;
result.append(text.getData());
}
} while ((node = node.getNextSibling()) != null);
}
return result.toString().trim();
}
private static class ButtonGroupWrapper {
private ButtonGroup _group;
private AbstractButton _dummy;
public ButtonGroupWrapper() {
_group = new ButtonGroup();
_dummy = new JRadioButton();
// We need a dummy button to have the appearance of all of
// the radio buttons being in an unselected state.
//
// From:
// http://java.sun.com/j2se/1.5/docs/api/javax/swing/ButtonGroup.html
//
// "There is no way to turn a button programmatically to 'off', in
// order to clear the button group. To give the appearance of 'none
// selected', add an invisible radio button to the group and then
// programmatically select that button to turn off all the displayed
// radio buttons. For example, a normal button with the label 'none'
// could be wired to select the invisible radio button.
_group.add(_dummy);
}
public void add(AbstractButton b) {
_group.add(b);
}
public void clearSelection() {
_group.setSelected(_dummy.getModel(), true);
}
}
}