/*
 * Copyright 2016 Crown Copyright
 *
 * 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 stroom.widget.button.client;

public interface ToggleButtonView extends ButtonView {

    void setState(final boolean isOn);

    /**
     * Alias for {@link ToggleButtonView#setState(boolean)} with true as the value.
     */
    default void setOn() {
        setState(true);
    }

    /**
     * Alias for {@link ToggleButtonView#setState(boolean)} with false as the value.
     */
    default void setOff() {
        setState(false);
    }

    boolean getState();

    /**
     * @return Alias for {@link ToggleButtonView#getState()}
     */
    default boolean isOn() {
        return getState();
    }

    /**
     * @return Alias for NOT {@link ToggleButtonView#getState()}
     */
    default boolean isOff() {
        return !getState();
    }
}
