001package org.gwtbootstrap3.client.ui.base;
002
003/*
004 * #%L
005 * GwtBootstrap3
006 * %%
007 * Copyright (C) 2013 GwtBootstrap3
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 * 
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 * 
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022
023/**
024 * A widget that implements this interface can be put in a "readonly"
025 * state.
026 */
027public interface HasReadOnly {
028
029    /**
030     * Determines whether or not the widget is read-only.
031     * 
032     * @return <code>true</code> if the widget is currently read-only,
033     *         <code>false</code> if the widget is currently editable
034     */
035    boolean isReadOnly();
036
037    /**
038     * Turns read-only mode on or off.
039     * 
040     * @param readOnly if <code>true</code>, the widget becomes read-only; if
041     *          <code>false</code> the widget becomes editable
042     */
043    void setReadOnly(boolean readOnly);
044
045}