Slider.java

/*
 * This file is part of SpoutcraftPlugin.
 *
 * Copyright (c) 2011 SpoutcraftDev <http://spoutcraft.org//>
 * SpoutcraftPlugin is licensed under the GNU Lesser General Public License.
 *
 * SpoutcraftPlugin is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * SpoutcraftPlugin is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.getspout.spoutapi.gui;

import org.getspout.spoutapi.event.screen.SliderDragEvent;

/**
 * The GenericSlider is a bar with which a user can set a value.
 * <p/>
 * The value is a float between 0f to 1f representing how far from the left
 * the slider is.
 */
public interface Slider extends Control, Label {
	/**
	 * Gets the slider position (between 0.0f and 1.0f)
	 * @return slider position
	 */
	public float getSliderPosition();

	/**
	 * Sets the slider position. Values below 0.0f are rounded to 0, and values above 1.0f are rounded to 1
	 * @param value to set
	 * @return slider
	 */
	public Slider setSliderPosition(float value);

	@Override
	public Slider setText(String text);

	@Override
	public Slider setTextColor(Color color);

	@Override
	public Slider setAuto(boolean auto);

	@Override
	public Slider setAlign(WidgetAnchor align);

	/**
	 * Fires when this slider is dragged on the screen.
	 * <p/>
	 * This event is also sent to the screen listener, afterwards.
	 * @param event
	 */
	public void onSliderDrag(SliderDragEvent event);
}