com.helger.photon.bootstrap4.utils

Class BootstrapSpacingBuilder

java.lang.Object

com.helger.photon.bootstrap4.utils.BootstrapSpacingBuilder

All Implemented Interfaces:

com.helger.html.css.ICSSClassProvider, Serializable

public class BootstrapSpacingBuilder
extends Object
implements com.helger.html.css.ICSSClassProvider, Serializable

Utility class to build a generic spacing.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BootstrapSpacingBuilder()

Method Summary

Modifier and Type	Method and Description
static BootstrapSpacingBuilder	createMarginBuilder()
static BootstrapSpacingBuilder	createPaddingBuilder()
String	getCSSClass()
BootstrapSpacingBuilder	grid(EBootstrapGridType eGrid) Set the grid type.
BootstrapSpacingBuilder	property(EBootstrapSpacingPropertyType eProperty) Set the property type.
BootstrapSpacingBuilder	side(EBootstrapSpacingSideType eSide) Set the edge type.
BootstrapSpacingBuilder	size(int nSize) Number of grid elements to "margin" and "padding" (0 = x*0, 1 = x*.25, 2 = x*.5, 3 = x*1, 4 = x*1.5, 5 = x*3)
BootstrapSpacingBuilder	sizeAuto() Think of it as a shortcut for size (-1) even though this wont work

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BootstrapSpacingBuilder

public BootstrapSpacingBuilder()

Method Detail

property

@Nonnull
public BootstrapSpacingBuilder property(@Nonnull
                                                  EBootstrapSpacingPropertyType eProperty)

Set the property type. Default is "margin".

Parameters:

eProperty - Property type. May not be null.

Returns:

this for chaining

side

@Nonnull
public BootstrapSpacingBuilder side(@Nonnull
                                              EBootstrapSpacingSideType eSide)

Set the edge type. Default is "all".

Parameters:

eSide - Edge type. May not be null.

Returns:

this for chaining

grid

@Nonnull
public BootstrapSpacingBuilder grid(@Nonnull
                                              EBootstrapGridType eGrid)

Set the grid type. Default is "xs" which means valid for all.

Parameters:

eGrid - Grid type. May not be null.

Returns:

this for chaining

size

@Nonnull
public BootstrapSpacingBuilder size(int nSize)

Number of grid elements to "margin" and "padding" (0 = x*0, 1 = x*.25, 2 = x*.5, 3 = x*1, 4 = x*1.5, 5 = x*3)

Parameters:

nSize - Size from 0 to 5 ("-1" for "auto" is not allowed here)

Returns:

this for chaining

See Also:

for automatic

sizeAuto

@Nonnull
public BootstrapSpacingBuilder sizeAuto()

Think of it as a shortcut for size (-1) even though this wont work

Returns:

this for chaining

See Also:

size(int)

getCSSClass

@Nonnull
public String getCSSClass()

Specified by:

getCSSClass in interface com.helger.html.css.ICSSClassProvider

createMarginBuilder

@Nonnull
 @ReturnsMutableCopy
public static BootstrapSpacingBuilder createMarginBuilder()

createPaddingBuilder

@Nonnull
 @ReturnsMutableCopy
public static BootstrapSpacingBuilder createPaddingBuilder()