HasVisibility.java

/*
 *  Copyright 2012 GWT-Bootstrap
 *
 *  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.github.gwtbootstrap.client.ui.base;

/**
 * Interface for components that can be shown or hidden.
 * 
 * @since 2.0.4.0
 * 
 * @author Carlos Alexandro Becker
 * 
 */
public interface HasVisibility {

	/**
	 * Shows the widget if it was previously hidden.
	 */
	void show();

	/**
	 * Hides the widget if it was previously shown.
	 */
	void hide();

	/**
	 * Toggles the view state of the widget.
	 * 
	 * <p>
	 * It will be hidden if it was previously shown and shown if it was
	 * previously hidden.
	 */
	void toggle();
}