com.izforge.izpack.panels.userinput.field.SimpleChoiceReader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of izpack-panel Show documentation
There is a newer version: 5.2.2
package com.izforge.izpack.panels.userinput.field;

import com.izforge.izpack.api.adaptator.IXMLElement;
import com.izforge.izpack.api.data.InstallData;
import com.izforge.izpack.api.exception.IzPackException;
import com.izforge.izpack.api.rules.RulesEngine;
import com.izforge.izpack.panels.userinput.processor.Processor;

import java.util.ArrayList;
import java.util.List;
import java.util.StringTokenizer;

public class SimpleChoiceReader extends FieldReader implements ChoiceFieldConfig
{

    /**
     * The choice element name.
     */
    public static final String CHOICE = "choice";

    /**
     * The installation data.
     */
    private InstallData installData;

    /**
     * The fallback value of a radiobutton marked checked.
     */
    private String defaultValue;


    /**
     * Constructs a {@code SimpleChoiceReader}.
     *
     * @param field  the field element to read
     * @param config the configuration
     */
    public SimpleChoiceReader(IXMLElement field, Config config, InstallData installData)
    {
        super(field, config);
        this.installData = installData;

        for (IXMLElement choice : getSpec().getChildrenNamed(CHOICE))
        {
            if (getConfig().getBoolean(choice, "set", false))
            {
                defaultValue = config.getAttribute(choice, "value");
                break;
            }
        }
    }

    /**
     * Returns the choices.
     *
     * @return the choices
     */
    public List getChoices()
    {
        List result = new ArrayList();
        Config config = getConfig();
        for (IXMLElement choice : getSpec().getChildrenNamed(CHOICE))
        {
            String processorClass = choice.getAttribute("processor");
            String conditionId = config.getString(choice, "conditionid", null);

            if (processorClass != null && !"".equals(processorClass))
            {
                String values;
                try
                {
                    Processor processor = config.getFactory().create(processorClass, Processor.class);
                    values = processor.process(null);
                }
                catch (Throwable exception)
                {
                    throw new IzPackException("Failed to get choices from processor=" + processorClass + " in "
                            + config.getContext(choice), exception);
                }
                StringTokenizer tokenizer = new StringTokenizer(values, ":");

                while (tokenizer.hasMoreTokens())
                {
                    String token = tokenizer.nextToken();
                    result.add(new Choice(token, token, conditionId));
                }
            }
            else
            {
                String value = config.getAttribute( choice, "value" );
                String label = this.installData.getVariables().replace( getText( choice ) );
                result.add( new Choice( value, label, conditionId ) );
            }
        }
        return result;
    }

    /**
     * Determines if a choice is selected.
     * 
     * A choice is selected if:
     * 

     * the variable value is the same as the choice "value" attribute; or
     * the "set" attribute is 'true'
     * 
     *
     * @param value         the choice value
     * @param choice        the choice element
     * @param variableValue the variable value. May be {@code null}
     * @return {@code true} if the choice is selected
     */
    protected boolean isSelected(String value, IXMLElement choice, String variableValue)
    {
        boolean result = false;
        if (variableValue != null)
        {
            if (variableValue.equals(value))
            {
                result = true;
            }
        }
        else
        {
            result = (defaultValue != null && defaultValue.equals(variableValue));
        }
        return result;
    }

    @Override
    public String getDefaultValue()
    {
        return defaultValue;
    }

    /**
     * Returns the index of the selected choice.
     * 
     * A choice is selected if:
     * 

     * the variable value is the same as the choice "value" attribute; or
     * the "set" attribute is 'true'
     * 
     * 
     * This is only valid after {@link #()} is invoked.
     *
     * @return the selected index or {@code -1} if no choice is selected
     */
    public int getSelectedIndex(String variable)
    {
        int selected = 0;
        int result = 0;
        Config config = getConfig();
        RulesEngine rules = installData.getRules();
        String variableValue = installData.getVariable(variable);
        for (IXMLElement choice : getSpec().getChildrenNamed(CHOICE))
        {
            String value = config.getAttribute(choice, "value");
            String conditionId = config.getString(choice, "conditionid", null);
            boolean isSet = config.getBoolean(choice, "set", false);
            if(variableValue == null)
            {
                if (isSet)
                {
                    result = selected;
                    break;
                }
            }
            else
            {
                if (isDisplayed(rules, conditionId) && isSelected(value, choice, variableValue))
                {
                    return  selected;
                }
            }
            selected ++;
        }
        return result;
    }

    private boolean isDisplayed(RulesEngine rules, String conditionId)
    {
        return (rules == null || conditionId == null || rules.isConditionTrue(conditionId));
    }
}