/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.cocoon.forms.formmodel;

import org.apache.cocoon.forms.FormsException;

/**
 * Definition for a {@link Submit}.
 *
 * @see SubmitDefinitionBuilder
 * @version $Id$
 */
public class SubmitDefinition extends ActionDefinition {

    private boolean validateForm;

    
    public SubmitDefinition() {
        validateForm = true;
    }

    /**
     * initialize this definition with the other, sort of like a copy constructor
     */
    public void initializeFrom(WidgetDefinition definition) throws Exception {
        super.initializeFrom(definition);

        if (!(definition instanceof SubmitDefinition)) {
            throw new FormsException("Ancestor definition " + definition.getClass().getName() + " is not a SubmitDefinition.",
                                     getLocation());
        }

        SubmitDefinition other = (SubmitDefinition) definition;

        this.validateForm = other.validateForm;
    }

    public void setValidateForm(boolean validateForm) {
        checkMutable();
        this.validateForm = validateForm;
    }

    public Widget createInstance() {
        return new Submit(this, validateForm);
    }
}