com.sksamuel.jqm4gwt.form.elements.JQMRadioset Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jqm4gwt-standalone Show documentation
Show all versions of jqm4gwt-standalone Show documentation
jqm4gwt bundled with all of its dependencies
The newest version!
package com.sksamuel.jqm4gwt.form.elements;
import java.util.ArrayList;
import java.util.List;
import com.google.gwt.dom.client.Document;
import com.google.gwt.dom.client.Element;
import com.google.gwt.event.dom.client.BlurHandler;
import com.google.gwt.event.dom.client.ClickEvent;
import com.google.gwt.event.dom.client.ClickHandler;
import com.google.gwt.event.dom.client.HasClickHandlers;
import com.google.gwt.event.logical.shared.HasSelectionHandlers;
import com.google.gwt.event.logical.shared.SelectionEvent;
import com.google.gwt.event.logical.shared.SelectionHandler;
import com.google.gwt.event.logical.shared.ValueChangeEvent;
import com.google.gwt.event.logical.shared.ValueChangeHandler;
import com.google.gwt.event.shared.GwtEvent.Type;
import com.google.gwt.event.shared.HandlerRegistration;
import com.google.gwt.uibinder.client.UiChild;
import com.google.gwt.user.client.ui.HasValue;
import com.google.gwt.user.client.ui.Label;
import com.google.gwt.user.client.ui.TextBox;
import com.google.gwt.user.client.ui.UIObject;
import com.google.gwt.user.client.ui.Widget;
import com.sksamuel.jqm4gwt.HasMini;
import com.sksamuel.jqm4gwt.HasOrientation;
import com.sksamuel.jqm4gwt.HasText;
import com.sksamuel.jqm4gwt.IconPos;
import com.sksamuel.jqm4gwt.JQMCommon;
import com.sksamuel.jqm4gwt.JQMWidget;
import com.sksamuel.jqm4gwt.Orientation;
import com.sksamuel.jqm4gwt.events.HasTapHandlers;
import com.sksamuel.jqm4gwt.events.JQMComponentEvents;
import com.sksamuel.jqm4gwt.events.JQMHandlerRegistration;
import com.sksamuel.jqm4gwt.events.JQMHandlerRegistration.WidgetHandlerCounter;
import com.sksamuel.jqm4gwt.events.TapEvent;
import com.sksamuel.jqm4gwt.events.TapHandler;
import com.sksamuel.jqm4gwt.form.JQMFieldContainer;
import com.sksamuel.jqm4gwt.form.JQMFieldset;
import com.sksamuel.jqm4gwt.html.Legend;
/**
* @author Stephen K Samuel [email protected] 24 May 2011 08:17:31
*
* A widget that is a collection of one or more radio buttons. All radio
* buttons must belong to a radioset. All radio buttons in a set are
* grouped and styled together.
*
* Use in UiBinder Templates
*
* When working with JQMRadioset in
* {@link com.google.gwt.uibinder.client.UiBinder UiBinder} templates, you
* can add Radio buttons via child elements. For example:
*
* <jqm:form.elements.JQMRadioset>
* <jqm:radio>
* <jqm:form.elements.JQMRadio text="radio_A_Text" value="a"/>
* <jqm:form.elements.JQMRadio text="radio_B_Text" value="b"/>
* </jqm:radio>
* </jqm:form.elements.JQMRadioset>
*
*
*/
public class JQMRadioset extends JQMFieldContainer implements HasText, HasValue,
HasSelectionHandlers, HasOrientation, HasMini,
JQMFormWidget, HasClickHandlers, HasTapHandlers {
private boolean valueChangeHandlerInitialized;
/**
* The panel that is used for the controlgroup container
*/
private JQMFieldset fieldset;
private Legend legend;
private final List radios = new ArrayList();
private String theme;
/**
* Creates a new {@link JQMRadioset} with no label
*/
public JQMRadioset() {
this(null);
}
/**
* Creates a new {@link JQMRadioset} with the label text set to the given value
*
* @param text - the text for the label
*/
public JQMRadioset(String text) {
setupFieldset(text);
}
private void setupFieldset(String labelText) {
if (fieldset != null) {
boolean horz = fieldset.isHorizontal();
boolean vert = fieldset.isVertical();
IconPos iconPos = getIconPos();
boolean mini = isMini();
remove(fieldset);
fieldset = new JQMFieldset();
if (horz) fieldset.setHorizontal();
if (vert) fieldset.setVertical();
setIconPos(iconPos);
setMini(mini);
} else {
// the fieldset is the inner container and is contained inside the flow
fieldset = new JQMFieldset();
}
fieldset.getElement().setId(Document.get().createUniqueId());
add(fieldset);
// the legend must be added to the fieldset
legend = new Legend();
legend.setText(labelText);
fieldset.add(legend);
}
BlurHandler blurHandler;
ArrayList blurHandlers = new ArrayList();
private void addRadiosBlurHandler(final BlurHandler handler) {
for (JQMRadio r : radios) {
TextBox radio = r.getInput();
blurHandlers.add(radio.addClickHandler(new ClickHandler() {
@Override
public void onClick(ClickEvent event) {
handler.onBlur(null);
}
}));
}
}
private void clearBlurHandlers() {
for (HandlerRegistration blurHandler : blurHandlers) blurHandler.removeHandler();
blurHandlers.clear();
}
@Override
protected void onLoad() {
super.onLoad();
if (blurHandler != null && blurHandlers.size() == 0) addRadiosBlurHandler(blurHandler);
}
@Override
protected void onUnload() {
clearBlurHandlers();
super.onUnload();
}
/**
* no-op implementation required for {@link JQMFormWidget}
*/
@Override
public HandlerRegistration addBlurHandler(final BlurHandler handler) {
this.blurHandler = handler;
clearBlurHandlers();
addRadiosBlurHandler(handler);
return null;
}
@Override
public HandlerRegistration addClickHandler(ClickHandler handler) {
return addDomHandler(handler, ClickEvent.getType());
}
@Override
public HandlerRegistration addTapHandler(TapHandler handler) {
// this is not a native browser event so we will have to manage it via JS
return JQMHandlerRegistration.registerJQueryHandler(new WidgetHandlerCounter() {
@Override
public int getHandlerCountForWidget(Type type) {
return getHandlerCount(type);
}
}, this, handler, JQMComponentEvents.TAP_EVENT, TapEvent.getType());
}
@Override
public Label addErrorLabel() {
return null;
}
/**
* Adds a new radio button to this radioset using the given string for both
* the value and the text. Returns a JQMRadio instance which can be used to
* change the value and label of the radio button.
*
* This method is the same as calling addRadio(String, String) with the same
* string twice.
*
* @param value
* the value to associate with this radio option. This will be
* the value returned by methods that query the selected value.
* The value will also be used for the label.
*
* @return a JQMRadio instance to adjust the added radio button
*/
public JQMRadio addRadio(String value) {
return addRadio(value, value);
}
/**
* Adds a new radio button to this radioset using the given value and text.
* Returns a JQMRadio instance which can be used to change the value and
* label of the radio button.
*
* @param value
* the value to associate with this radio option. This will be
* the value returned by methods that query the selected value.
*
* @param text
* the label to show for this radio option.
*
* @return a JQMRadio instance to adjust the added radio button
*/
public JQMRadio addRadio(String value, String text) {
JQMRadio radio = new JQMRadio(value, text);
addRadio(radio);
return radio;
}
/**
* UiBinder call method to add a radio button
*
* @param radio
*/
@UiChild(tagname = "radio")
public void addRadio(JQMRadio radio) {
radio.setName(fieldset.getId());
radios.add(radio);
radio.setTheme(theme);
fieldset.add(radio.getInput());
fieldset.add(radio.getLabel());
}
public void clear() {
radios.clear();
setupFieldset(getText());
valueChangeHandlerInitialized = false; // based on radios
}
@Override
public String getTheme() {
if (radios.isEmpty()) return theme;
return radios.get(0).getTheme();
}
@Override
public void setTheme(String themeName) {
theme = themeName;
for (JQMRadio radio : radios) radio.setTheme(theme);
}
@Override
public JQMWidget withTheme(String themeName) {
setTheme(themeName);
return this;
}
private void initValueChangeHandler() {
// Initialization code
if (!valueChangeHandlerInitialized) {
valueChangeHandlerInitialized = true;
for (JQMRadio r : radios) {
TextBox radio = r.getInput();
radio.addClickHandler(new ClickHandler() {
@Override
public void onClick(ClickEvent event) {
SelectionEvent.fire(JQMRadioset.this, getValue());
ValueChangeEvent.fire(JQMRadioset.this, getValue());
}
});
}
}
}
@Override
public HandlerRegistration addSelectionHandler(SelectionHandler handler) {
initValueChangeHandler();
return addHandler(handler, SelectionEvent.getType());
}
@Override
public HandlerRegistration addValueChangeHandler(ValueChangeHandler handler) {
initValueChangeHandler();
return addHandler(handler, ValueChangeEvent.getType());
}
/**
* Alias for getValue()
*/
public String getSelectedValue() {
return getValue();
}
/**
* Returns the text used for the main label
*/
@Override
public String getText() {
return legend.getText();
}
/**
*
* Note: this method will return null until after the jquery init phase has
* completed. That means if you call getValue() on an element in the initial
* construction of a page then it will return null.
*
* @return the value of the currently selected radio button or null if no
* button is currently selected.
*
*/
@Override
public String getValue() {
for (JQMRadio r : radios) {
TextBox radio = r.getInput();
Element element = radio.getElement();
if (isChecked(element)) {
return element.getAttribute("value");
}
}
return null;
}
/**
* Returns the value of the radio option at the given index.
*
* @return the value of the k'th radio option
*/
public String getValue(int k) {
return radios.get(k).getElement().getAttribute("value");
}
/**
* Returns the value of the button that has the given id
*
* @return the value of the button with the given id
*/
private String getValueForId(String id) {
for (int k = 0; k < fieldset.getWidgetCount(); k++) {
Widget widget = fieldset.getWidget(k);
if (id.equals(widget.getElement().getAttribute("id")))
return widget.getElement().getAttribute("value");
}
return null;
}
/**
* Removes the given {@link JQMRadio} from this radioset
*
* @param radio - the radio to remove
*/
public void removeRadio(JQMRadio radio) {
if (radio == null) return;
TextBox inp = radio.getInput();
if (inp != null) {
radios.remove(radio);
fieldset.remove(inp);
}
if (radio.getLabel() != null) fieldset.remove(radio.getLabel());
}
/**
* Removes the {@link JQMRadio} button that has the given value
*
* @param value
*/
public void removeRadio(String value) {
// TODO traverse all elements removing anything that has a "for" for
// this id or actually has this id
}
@Override
public boolean isHorizontal() {
return fieldset.isHorizontal();
}
@Override
public void setHorizontal() {
fieldset.withHorizontal();
}
@Override
public JQMRadioset withHorizontal() {
setHorizontal();
return this;
}
@Override
public boolean isVertical() {
return fieldset.isVertical();
}
@Override
public void setVertical() {
fieldset.withVertical();
}
@Override
public JQMRadioset withVertical() {
setVertical();
return this;
}
/**
* Sets the selected value. This is an alias for setValue(String)
*
* @see #setValue(String)
*/
public void setSelectedValue(String value) {
setValue(value);
}
@Override
public void setText(String text) {
legend.setText(text);
}
@Override
public void setValue(String value) {
setValue(value, false);
}
/**
* Sets the currently selected radio to the given value.
*/
@Override
public void setValue(String value, boolean fireEvents) {
String oldValue = fireEvents ? getValue() : null;
boolean changed = false;
for (JQMRadio r : radios) { // first we have to uncheck already checked radios (UI refresh issue)
TextBox radio = r.getInput();
if (!isChecked(radio)) continue;
boolean checked = value != null && value.equals(radio.getValue()) ? true : false;
if (!checked) {
setChecked(radio, false);
changed = true;
}
}
for (JQMRadio r : radios) {
TextBox radio = r.getInput();
boolean checked = value != null && value.equals(radio.getValue()) ? true : false;
if (isChecked(radio) != checked) {
setChecked(radio, checked);
changed = true;
}
}
if (fireEvents && changed) {
String newValue = getValue();
boolean eq = newValue == oldValue || newValue != null && newValue.equals(oldValue);
if (!eq) {
SelectionEvent.fire(this, newValue);
ValueChangeEvent.fire(this, newValue);
}
}
}
protected void setChecked(TextBox radio, boolean value) {
if (radio == null) return;
if (radio.isAttached()) setCheckedAndRefresh(radio.getElement(), value);
else setChecked(radio.getElement(), value);
}
protected boolean isChecked(TextBox radio) {
return radio != null && isChecked(radio.getElement());
}
private static native boolean isChecked(Element elt) /*-{
if ($wnd.$ === undefined || $wnd.$ === null) return false; // jQuery is not loaded
return $wnd.$(elt).prop("checked") ? true : false;
}-*/;
private static native void setCheckedAndRefresh(Element elt, boolean value) /*-{
if ($wnd.$ === undefined || $wnd.$ === null) return; // jQuery is not loaded
var w = $wnd.$(elt);
if (w.data('mobile-checkboxradio') !== undefined) {
w.prop('checked', value).checkboxradio('refresh');
} else {
w.prop('checked', value);
}
}-*/;
private static native void setChecked(Element elt, boolean value) /*-{
if ($wnd.$ === undefined || $wnd.$ === null) return; // jQuery is not loaded
$wnd.$(elt).prop('checked', value);
}-*/;
public void refresh() {
refreshAll(fieldset.getElement());
}
private static native void refreshAll(Element elt) /*-{
$wnd.$(elt).find("input[type='radio']").each(function() {
var w = $wnd.$(this);
if (w.data('mobile-checkboxradio') !== undefined) {
w.checkboxradio('refresh');
}
});
}-*/;
/**
* Returns the number of radio options set on this radioset
*
* @return the integer number of options
*/
public int size() {
return radios.size();
}
public void setRadioVisible(int index, boolean visible) {
if (index < 0 || index >= radios.size()) return;
JQMRadio r = radios.get(index);
Element p = r.getElement().getParentElement();
while (p != null) {
if (JQMCommon.hasStyle(p, "ui-radio")) {
UIObject.setVisible(p, visible);
break;
}
p = p.getParentElement();
}
}
public boolean isRadioVisible(int index) {
if (index < 0 || index >= radios.size()) return false;
JQMRadio r = radios.get(index);
Element p = r.getElement().getParentElement();
while (p != null) {
if (JQMCommon.hasStyle(p, "ui-radio")) {
return UIObject.isVisible(p);
}
p = p.getParentElement();
}
return false;
}
@Override
public JQMRadioset withText(String text) {
setText(text);
return this;
}
public void setOrientation(Orientation value) {
HasOrientation.Support.setOrientation(this, value);
}
public Orientation getOrientation() {
return HasOrientation.Support.getOrientation(this);
}
public IconPos getIconPos() {
return JQMCommon.getIconPos(fieldset);
}
/**
* Sets the position of the icon.
*/
public void setIconPos(IconPos pos) {
JQMCommon.setIconPos(fieldset, pos);
}
@Override
public boolean isMini() {
return JQMCommon.isMini(fieldset);
}
/**
* If set to true then renders a smaller version of the standard-sized element.
*/
@Override
public void setMini(boolean mini) {
JQMCommon.setMini(fieldset, mini);
}
/**
* If set to true then renders a smaller version of the standard-sized element.
*/
@Override
public JQMRadioset withMini(boolean mini) {
setMini(mini);
return this;
}
}