com.izforge.izpack.panels.userinput.console.ConsoleInputField 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
The newest version!
/*
 * IzPack - Copyright 2001-2012 Julien Ponge, All Rights Reserved.
 *
 * http://izpack.org/
 * http://izpack.codehaus.org/
 *
 * Copyright 2012 Tim Anderson
 *
 * Licensed 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 com.izforge.izpack.panels.userinput.console;

import com.izforge.izpack.api.handler.Prompt;
import com.izforge.izpack.panels.userinput.field.Field;
import com.izforge.izpack.panels.userinput.field.ValidationStatus;
import com.izforge.izpack.util.Console;

/**
 * A field which accepts string input.
 *
 * @author Tim Anderson
 */
public abstract class ConsoleInputField extends ConsoleField
{

    /**
     * Constructs a {@code ConsoleInputField}.
     *
     * @param field   the field
     * @param console the console
     * @param prompt  the prompt
     */
    public ConsoleInputField(Field field, Console console, Prompt prompt)
    {
        super(field, console, prompt);
    }

    /**
     * Displays the field.
     * 
     * For fields that update variables, this collects input and validates it.
     *
     * @return {@code true} if the field was displayed and validated successfully
     */
    @Override
    public boolean display()
    {
        boolean result = false;
        printDescription();
        Field field = getField();
        String label = field.getLabel(true);
        String initialValue = field.getInitialValue();
        
        if (isReadonly())
        {
            println(label + " [" + initialValue + "] ");
            field.setValue(initialValue);
            return true;
        }
        else
        {
            if (initialValue == null)
            {
                initialValue = "";
            }
            String value = getConsole().prompt(label + " [" + initialValue + "] ", initialValue);
            if (value != null)
            {
                ValidationStatus status = validate(value);
                if (!status.isValid())
                {
                    error(status.getMessage());
                }
                else
                {
                    field.setValue(value);
                    result = true;
                }
            }
        }

        return result;
    }

    /**
     * Validates a value.
     *
     * @param value the value to validate
     * @return the validation status
     */
    protected ValidationStatus validate(String value)
    {
        return getField().validate(value);
    }
}