com.jwebmp.plugins.bootstrap.buttons.BSComponentButtonOptions 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.buttons;

import com.jwebmp.core.utilities.StaticStrings;
import com.jwebmp.plugins.bootstrap.options.IBSComponentOptions;

import static com.jwebmp.core.utilities.StaticStrings.*;

/**
 * Buttons
 * 
 * Use Bootstrap’s custom button styles for actions in forms, dialogs, and more. Includes support for a handful of contextual variations, sizes, states, and more.
 *
 * @author GedMarc
 * @version 1.0
 * @since 01 Jan 2017
 */
public enum BSComponentButtonOptions
		implements IBSComponentOptions
{
	/**
	 * Adds basic styling to any button
	 */
	Btn,
	/**
	 * Indicates a default/standard button
	 */
	Btn_Default,
	/**
	 * Provides extra visual weight and identifies the primary action in a set of buttons
	 */
	Btn_Primary,
	/**
	 * Provides extra visual weight and identifies the primary action in a set of buttons
	 */
	Btn_Secondary,
	/**
	 * Indicates a successful or positive action
	 */
	Btn_Success,
	/**
	 * Contextual button for informational alert messages
	 */
	Btn_Info,
	/**
	 * Indicates caution should be taken with this action
	 */
	Btn_Warning,
	/**
	 * Indicates a dangerous or potentially negative action
	 */
	Btn_Danger,
	/**
	 * Makes a button look like a link (will still have button behavior)
	 */
	Btn_Link,
	/**
	 * Makes a large button
	 */
	Btn_Lg,
	/**
	 * Makes a small button
	 */
	Btn_Sm,
	/**
	 * Makes an extra small button
	 */
	Btn_Xs,
	/**
	 * Makes a block_level button (spans the full width of the parent element)
	 */
	Btn_Block,
	/**
	 * Provides extra visual weight and identifies the primary action in a set of buttons with outline button mode
	 */
	Btn_Outline_Primary,
	/**
	 * Provides extra visual weight and identifies the primary action in a set of buttons with outline button mode
	 */
	Btn_Outline_Secondary,
	/**
	 * Indicates a successful or positive action with outline button mode
	 */
	Btn_Outline_Success,
	/**
	 * Contextual button for informational alert messages with outline button mode
	 */
	Btn_Outline_Info,
	/**
	 * Indicates caution should be taken with this action with outline button mode
	 */
	Btn_Outline_Warning,
	/**
	 * Indicates a dangerous or potentially negative action with outline button mode
	 */
	Btn_Outline_Danger,
	;

	@Override
	public String toString()
	{
		return name().toLowerCase()
		             .replace(StaticStrings.CHAR_UNDERSCORE, CHAR_DASH);
	}
}