001/*
002 *  Copyright 2012 GWT-Bootstrap
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package com.github.gwtbootstrap.client.ui.base;
017
018/**
019 * Interface for components that can be shown or hidden.
020 * 
021 * @since 2.0.4.0
022 * 
023 * @author Carlos Alexandro Becker
024 * 
025 */
026public interface HasVisibility {
027
028        /**
029         * Shows the widget if it was previously hidden.
030         */
031        void show();
032
033        /**
034         * Hides the widget if it was previously shown.
035         */
036        void hide();
037
038        /**
039         * Toggles the view state of the widget.
040         * 
041         * <p>
042         * It will be hidden if it was previously shown and shown if it was
043         * previously hidden.
044         */
045        void toggle();
046}