com.jwebmp.plugins.bootstrap4.options.BSResponsiveOptions 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.options;

import com.jwebmp.core.utilities.StaticStrings;

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

/**
 * Responsive utilities
 * 
 * For faster mobile-friendly development, use these utility classes for showing and hiding content by device via media query. Also
 * included are utility classes for toggling content when printed.
 * 

 * Try to use these on a limited basis and avoid creating entirely different versions of the same site. Instead, use them to complement
 * each device’s presentation. Available classes
 * 
 * The .hidden-*-up classes hide the element when the viewport is at the given breakpoint or wider. For example, .hidden-md-up hides an
 * element on medium, large, and extra-large viewports. The
 * .hidden-*-down classes hide the element when the viewport is at the given breakpoint or smaller. For example, .hidden-md-down hides an
 * element on extra-small, small, and medium viewports. There are
 * no explicit “visible”/”show” responsive utility classes; you make an element visible by simply not hiding it at that breakpoint size.
 * You can combine one .hidden-*-up class with one .hidden-*-down
 * class to show an element only on a given interval of screen sizes. For example, .hidden-sm-down.hidden-xl-up shows the element only on
 * medium and large viewports. Using multiple .hidden-*-up
 * classes or multiple .hidden-*-down classes is redundant and pointless. These classes don’t attempt to accommodate less common cases
 * where an element’s visibility can’t be expressed as a single
 * contiguous range of viewport breakpoint sizes; you will instead need to use custom CSS in such cases.
 *
 * @author GedMarc
 * @version 1.0
 * @since Oct 10, 2016
 */
public enum BSResponsiveOptions
		implements IBSComponentOptions
{
	Hidden("d-none"),
	/**
	 * Hide this component when small only
	 */
	Hidden_SM("d-sm-none"),
	/**
	 * Hide this component extra small only
	 */
	Hidden_XS("d-none"),
	/**
	 * Hide this component when medium
	 */
	Hidden_MD("d-md-none"),
	/**
	 * Hide this component when large
	 */
	Hidden_LG("d-lg-none"),
	/**
	 * Hide when XL
	 */
	Hidden_XL("d-xl-none"),
	/**
	 * Hide for XS and SM
	 */
	Hidden_XS_Down("d-none d-sm-block"),
	/**
	 * Hide for XS and SM
	 */
	Hidden_SM_Down("d-none d-md-block"),
	/**
	 * Hide for XS, SM and MD
	 */
	Hidden_MD_Down("d-none d-lg-block"),
	/**
	 * Only display on XL
	 */
	Hidden_LG_Down("d-none d-xl-block"),
	;

	private String newClasses;

	BSResponsiveOptions()
	{

	}

	BSResponsiveOptions(String newClasses)
	{
		this.newClasses = newClasses;
	}

	/**
	 * Replaces the text with its HTML class equivalent
	 *
	 * @return
	 */
	@Override
	public String toString()
	{
		return getNewClasses().toLowerCase()
		                      .replace(StaticStrings.CHAR_UNDERSCORE, CHAR_DASH);
	}

	public String getNewClasses()
	{
		return newClasses;
	}

	public void setNewClasses(String newClasses)
	{
		this.newClasses = newClasses;
	}

}