/*******************************************************************************
 * See the NOTICE file distributed with this work for additional information
 * regarding copyright ownership.
 * 
 * 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.
 ******************************************************************************/
/*
 * Copyright 2002-2004 the original author or authors.
 * 
 * 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 hr.fer.zemris.vhdllab.platform.remoting;

import javax.swing.JComponent;

import org.apache.commons.httpclient.Credentials;
import org.apache.commons.httpclient.UsernamePasswordCredentials;
import org.springframework.richclient.form.AbstractForm;
import org.springframework.richclient.form.FormModelHelper;
import org.springframework.richclient.form.builder.TableFormBuilder;

/**
 * This class provides a simple form for capturing a username and password from
 * the user. It also generates an {@link Credentials} token from the entered
 * values.
 * 
 * @author Larry Streepy
 * @see #getAuthentication()
 */
public class LoginForm extends AbstractForm {
    private static final String FORM_ID = "credentials";

    private LoginDetails loginDetails;

    private JComponent usernameField;
    private JComponent passwordField;

    /**
     * Constructor.
     */
    public LoginForm() {
        super(FORM_ID);

        loginDetails = createLoginDetails();
        setFormModel(FormModelHelper.createUnbufferedFormModel(loginDetails));
    }

    /**
     * Set the user name in the form.
     * 
     * @param userName
     *            to install
     */
    public void setUserName(String userName) {
        if (isControlCreated()) {
            getValueModel(LoginDetails.PROPERTY_USERNAME).setValue(userName);
        } else {
            loginDetails.setUsername(userName);
        }
    }

    /**
     * Set the password in the form.
     * 
     * @param password
     *            to install
     */
    public void setPassword(String password) {
        if (isControlCreated()) {
            getValueModel(LoginDetails.PROPERTY_PASSWORD).setValue(password);
        } else {
            loginDetails.setPassword(password);
        }
    }

    /**
     * Get an Authentication token that contains the current username and
     * password.
     * 
     * @return authentication token
     */
    public UsernamePasswordCredentials getAuthentication() {
        String username = loginDetails.getUsername().trim();
        String password = loginDetails.getPassword().trim();
        return new UsernamePasswordCredentials(username, password);
    }

    /**
     * Create the form object to hold our login information.
     * 
     * @return constructed form object
     */
    protected LoginDetails createLoginDetails() {
        return new LoginDetails();
    }

    /**
     * Construct the form with the username and password fields.
     */
    @Override
    protected JComponent createFormControl() {
        TableFormBuilder formBuilder = new TableFormBuilder(getBindingFactory());
        usernameField = formBuilder.add(LoginDetails.PROPERTY_USERNAME)[1];
        formBuilder.row();
        passwordField = formBuilder
                .addPasswordField(LoginDetails.PROPERTY_PASSWORD)[1];
        return formBuilder.getForm();
    }

    public boolean requestFocusInWindow() {
        // Put the focus on the right field
        String username = loginDetails.getUsername();
        JComponent field = (username != null && username.length() > 0) ? passwordField
                : usernameField;
        return field.requestFocusInWindow();
    }

}