com.izforge.izpack.panels.userinput.field.FieldView 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.field;

/**
 * The presentation of a field.
 *
 * @author Tim Anderson
 */
public interface FieldView
{

    /**
     * Returns the field.
     *
     * @return the field
     */
    Field getField();

    /**
     * Determines if the view is being displayed.
     *
     * @return {@code true} if the view is being displayed
     */
    boolean isDisplayed();

    /**
     * Determines if the view is being displayed.
     *
     * @param displayed {@code true} if the view is being displayed
     */
    void setDisplayed(boolean displayed);

    /**
     * Determines if the view is read-only.
     *
     * @return {@code true} if the view is read-only
     */
    boolean isReadonly();

    /**
     * Set the view read-only or not.
     *
     * @param displayed {@code true} if the view is read-only
     */
    void setReadonly(boolean readonly);

}