com.jwebmp.plugins.bootstrap4.alerts.BSAlertOptions Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jwebmp-bootstrap4 Show documentation
The JWebSwing implementation for Bootstrap 4
The newest version!
/*
 * 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.bootstrap4.alerts;

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

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

/**
 * Alerts are available for any length of text, as well as an optional dismiss button. For proper styling, use one of the four required
 * contextual classes (e.g., .alert-success). For inline dismissal,
 * use the alerts jQuery plugin.
 *
 * @author GedMarc
 * @version 1.0
 * @since 31 Dec 2016
 */
public enum BSAlertOptions
		implements IBSComponentOptions
{
	/**
	 * Alerts are available for any length of text, as well as an optional dismiss button. For proper styling, use one of the four required
	 * contextual classes (e.g., .alert-success). For inline
	 * dismissal, use the alerts jQuery plugin.
	 */
	Alert,
	/**
	 * Alerts are available for any length of text, as well as an optional dismiss button. For proper styling, use one of the four required
	 * contextual classes (e.g., .alert-success). For inline
	 * dismissal, use the alerts jQuery plugin.
	 */
	Alert_Success,
	/**
	 * Alerts are available for any length of text, as well as an optional dismiss button. For proper styling, use one of the four required
	 * contextual classes (e.g., .alert-success). For inline
	 * dismissal, use the alerts jQuery plugin.
	 */
	Alert_Warning,
	/**
	 * Alerts are available for any length of text, as well as an optional dismiss button. For proper styling, use one of the four required
	 * contextual classes (e.g., .alert-success). For inline
	 * dismissal, use the alerts jQuery plugin.
	 */
	Alert_Danger,
	/**
	 * Alerts are available for any length of text, as well as an optional dismiss button. For proper styling, use one of the four required
	 * contextual classes (e.g., .alert-success). For inline
	 * dismissal, use the alerts jQuery plugin.
	 */
	Alert_Info,
	/**
	 * Use the .alert-link utility class to quickly provide matching colored links within any alert.
	 */
	Alert_Primary,
	/**
	 * Use the .alert-link utility class to quickly provide matching colored links within any alert.
	 */
	Alert_Secondary,

	Alert_Heading,

	Alert_Link,
	/**
	 * Sets the alert theme to light
	 */
	Alert_Light,
	/**
	 * Sets the alert theme to light
	 */
	Alert_Dark,
	/**
	 * Be sure you’ve loaded the alert plugin, or the compiled Bootstrap JavaScript.
	 * 
	 * Add a dismiss button and the .alert-dismissible class, which adds extra padding to the right of the alert and positions the .close
	 * button.
	 * 

	 * On the dismiss button, add the data-dismiss="alert" attribute, which triggers the JavaScript functionality.
	 * 

	 * Be sure to use the button element with it for proper behavior across all devices.
	 * 

	 * To animate alerts when dismissing them, be sure to add the .fade and .in classes.
	 * 
	 */
	Alert_Dismissible;

	BSAlertOptions()
	{

	}

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

}