org.wings.SRadioButton Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of wings Show documentation
The newest version!
/*
 * Copyright 2000,2005 wingS development team.
 *
 * This file is part of wingS (http://wingsframework.org).
 *
 * wingS 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.
 *
 * Please see COPYING for the complete licence.
 */
package org.wings;


import org.wings.plaf.RadioButtonCG;

/**
 * Can be selected or deselected, and displays that state to the user.
 *
 * 
 * Example:
 * 

 * Radiobuttons:
 * One
 * Two
 * Three
 * 
 *
 * @author Armin Haaf
 */
public class SRadioButton
        extends SAbstractButton {

	/**
     * Creates an unselected radio button.
     *
     */
    public SRadioButton() {
        setType(RADIOBUTTON);
    }

    /**
     * Creates a unselected radio button with an initial text.
     *
     * @param label Text to display
     */
    public SRadioButton(String label) {
        super(label, RADIOBUTTON);
    }

    /**
     * Creates a radio button with a certain state.
     *
     * @param selected Whether the radio button is initially selected or not.
     */
    public SRadioButton(boolean selected) {
        this();
        setSelected(selected);
    }

    /**
     * Creates a radio button with a text-label and a state.
     *
     * @param label Text to display
     * @param selected Whether the radio button is initially selected or not.
     */
    public SRadioButton(String label, boolean selected) {
        this(selected);
        setText(label);
    }


    @Override
    public String getLowLevelEventId() {
        if (getGroup() != null && getShowAsFormComponent()) {
            return getGroup().getComponentId();
        } else {
            return super.getLowLevelEventId();
        } // end of if ()
    }

    /**
     * You cannot change type of radio button. 
     * Accepts only {@link SAbstractButton#RADIOBUTTON}
     */
    @Override
    public void setType(String t) {
        if (!RADIOBUTTON.equals(t))
            throw new IllegalArgumentException("type change not supported, type is fix: radiobutton");

        super.setType(t);
    }

    public void setCG(RadioButtonCG cg) {
        super.setCG(cg);
    }

    @Override
    public void processLowLevelEvent(String action, String... values) {
        processKeyEvents(values);
        if (action.endsWith("_keystroke"))
            return;

        delayEvents(true);

        boolean origSelected = isSelected();

        if (getShowAsFormComponent()) {
            if (values.length == 1) {
                // this happens if we've got a form component but
                // the CG uses icons since useIconsInForm is true
                if (getName().equals(values[0]) && !isSelected()) {
                    setSelected(true);
                }
            } else if (getGroup() == null) {
                // one hidden and one checked event from the form says select
                // it, else deselect it (typically only the hidden event)
                setSelected(values.length == 2);
            } else {
                int eventCount = 0;
                for (String value : values) {
                    // check the count of events, which are for me - with a
                    // button group, the value is my component id, if a event is
                    // for me
                    if (getName().equals(value)) {
                        eventCount++;
                    } // end of if ()
                } // end of for (int i=0; i<; i++)
                // one hidden and one checked event from the form says select
                // it, else deselect it (typically only the hidden event)
                setSelected(eventCount == 2);
            } // end of if ()
        } else {
            if (getGroup() != null) {
                getGroup().setDelayEvents(true);
                setSelected(parseSelectionToggle(values[0]));
                getGroup().setDelayEvents(false);
            } else {
                setSelected(parseSelectionToggle(values[0]));
            } // end of else
        }

        if (isSelected() != origSelected) {
            // got an event, that is a select...
            SForm.addArmedComponent(this);
        } // end of if ()

        delayEvents(false);
    }

    @Override
    protected boolean parseSelectionToggle(String toggleParameter) {
        if ("1".equals(toggleParameter) && !isSelected())
            return true;
        else
            return isSelected();
    }

    @Override
    public String getSelectionParameter() {
        if (getGroup() != null && getShowAsFormComponent()) {
            return getName();
        } else {
            return "1";
        }
    }

    @Override
    public String getDeselectionParameter() {
        if (getGroup() != null && getShowAsFormComponent()) {
            return getName();
        } else {
            return "0";
        }
    }
}