HasShowDelay.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 widgets that can have a delay when they are shown or hidden.
 * 
 * @since 2.0.4.0
 * 
 * @author Dominik Mayer
 * 
 */
public interface HasShowDelay {

	/**
	 * Sets the time to wait until the widget is shown.
	 * 
	 * @param delayInMilliseconds
	 *            the delay in milliseconds
	 */
	void setShowDelay(int delayInMilliseconds);

	/**
	 * Gets the time to wait until the widget is shown.
	 * 
	 * @return the delay in milliseconds
	 */
	int getShowDelay();

	/**
	 * Sets the time to wait until the widget is hidden.
	 * 
	 * @param delayInMilliseconds
	 *            the delay in milliseconds
	 */
	void setHideDelay(int delayInMilliseconds);

	/**
	 * Gets the time to wait until the widget is hidden.
	 * 
	 * @return the delay in milliseconds
	 */
	int getHideDelay();
}