com.jwebmp.plugins.bootstrap.progressbar.bar.IBSProgressBarDisplay Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jwebmp-bootstrap Show documentation

The JWebSwing implementation for Bootstrap

There is a newer version: 0.66.0.1

/*
 * Copyright (C) 2017 Marc Magon
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package com.jwebmp.plugins.bootstrap.progressbar.bar;

import com.jwebmp.core.base.html.Span;

/**
 * @param 
 *
 * @author GedMarc
 * @since 21 Feb 2017
 */
public interface IBSProgressBarDisplay
{

	/**
	 * Returns this label
	 *
	 * @return
	 */
	String getLabel();

	/**
	 * Gets the current max value
	 *
	 * @return
	 */
	double getMax();

	/**
	 * Returns this associated span
	 *
	 * @return
	 */
	Span getSpan();

	/**
	 * Returns a current theme, default is success
	 *
	 * @return
	 */
	BSProgressBarThemes getTheme();

	/**
	 * Returns the current percentage
	 *
	 * @return
	 */
	double getValue();

	/**
	 * Sets this label
	 *
	 * @param label
	 *
	 * @return
	 */
	J setLabel(String label);

	/**
	 * Sets the current max value
	 *
	 * @param max
	 *
	 * @return
	 */
	J setMax(double max);

	/**
	 * Returns the current min value
	 *
	 * @param min
	 *
	 * @return
	 */
	J setMin(double min);

	/**
	 * Sets the current theme
	 *
	 * @param theme
	 *
	 * @return
	 */
	J setTheme(BSProgressBarThemes theme);

	/**
	 * Sets the current percentage / width
	 *
	 * @param value
	 *
	 * @return
	 */
	J setValue(double value);

}