com.foreach.across.modules.bootstrapui.elements.Grid Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2019 the original author or authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.foreach.across.modules.bootstrapui.elements;

import org.apache.commons.lang3.StringUtils;

import java.util.*;

/**
 * Helper class that represents a Bootstrap grid layout: a number of columns ({@link Grid.Position}) with
 * one or more specifiers (eg. hidden, pull-right, width for different devices etc).
 * 
 * The static convenience methods {@link #create(int...)} help you easily create basic grids.
 * Example more complex grid layout:
 * 
 *     Grid.create(
 *       Grid.position( Device.MD.hidden(), Device.LG.width( Width.QUARTER ).asOffset() ),
 *       Grid.position( Device.SM.width( Width.THREE_QUARTERS ) )
 *     );
 * 
 * Would result in:
 *  *     Grid{[hidden-md col-lg-offset-3],[col-sm-9]}
 * 
 */
public class Grid extends ArrayList
{
	public static class Width
	{
		public static final int QUARTER = 3;
		public static final int THIRD = 4;
		public static final int HALF = 6;
		public static final int TWO_THIRDS = 8;
		public static final int THREE_QUARTERS = 9;
		public static final int FULL = 12;
	}

	public static class Columns
	{
		public static final int ONE = 1;
		public static final int TWO = 2;
		public static final int THREE = 3;
		public static final int FOUR = 4;
		public static final int FIVE = 5;
		public static final int SIX = 6;
		public static final int SEVEN = 7;
		public static final int EIGHT = 8;
		public static final int NINE = 9;
		public static final int TEN = 10;
		public static final int ELEVEN = 11;
		public static final int TWELVE = 12;
	}

	public interface DeviceGridLayout
	{
	}

	public static class SingleCssClassDeviceGridLayout implements DeviceGridLayout
	{
		private final String generatedClass;

		public SingleCssClassDeviceGridLayout( String generatedClass ) {
			this.generatedClass = generatedClass;
		}

		@Override
		public boolean equals( Object o ) {
			if ( this == o ) {
				return true;
			}
			if ( o == null || getClass() != o.getClass() ) {
				return false;
			}
			SingleCssClassDeviceGridLayout that = (SingleCssClassDeviceGridLayout) o;
			return Objects.equals( generatedClass, that.generatedClass );
		}

		@Override
		public int hashCode() {
			return Objects.hash( generatedClass );
		}

		@Override
		public String toString() {
			return generatedClass;
		}
	}

	public static class Device
	{
		public static final Device SM = new Device( "sm" );

		@Deprecated
		public static final Device XS = new Device( "xs" );

		public static final Device MD = new Device( "md" );
		public static final Device LG = new Device( "lg" );
		public static final Device XL = new Device( "xl" );

		@Deprecated
		public static final Device EXTRA_SMALL = XS;

		public static final Device SMALL = SM;
		public static final Device MEDIUM = MD;
		public static final Device LARGE = LG;
		public static final Device EXTRA_LARGE = XL;

		private final String token;
		private DeviceGridLayout hidden;
		private Visibility visible;

		public Device( String token ) {
			this.token = token;
			hidden = new SingleCssClassDeviceGridLayout( "hidden-" + token );
			visible = new Visibility( token );
		}

		public Column width( int columns ) {
			return new Column( token, columns );
		}

		public DeviceGridLayout hidden() {
			return hidden;
		}

		public Visibility visible() {
			return visible;
		}
	}

	public static class Visibility implements DeviceGridLayout
	{
		private final String token;

		public Visibility( String token ) {
			this.token = token;
		}

		public DeviceGridLayout block() {
			return new SingleCssClassDeviceGridLayout( "visible-" + token + "-block" );
		}

		public DeviceGridLayout inline() {
			return new SingleCssClassDeviceGridLayout( "visible-" + token + "-inline" );
		}

		public DeviceGridLayout inlineBlock() {
			return new SingleCssClassDeviceGridLayout( "visible-" + token + "-inline-block" );
		}

		public String toString() {
			return block().toString();
		}
	}

	public static class Column implements DeviceGridLayout
	{
		private final String token;
		private final int width;

		public Column( String token, int width ) {
			this.token = token;
			this.width = width;
		}

		public DeviceGridLayout asWidth() {
			return new SingleCssClassDeviceGridLayout( "col-" + token + "-" + width );
		}

		public DeviceGridLayout asOffset() {
			return new SingleCssClassDeviceGridLayout( "col-" + token + "-offset-" + width );
		}

		public DeviceGridLayout asPull() {
			return new SingleCssClassDeviceGridLayout( "col-" + token + "-pull-" + width );
		}

		public DeviceGridLayout asPush() {
			return new SingleCssClassDeviceGridLayout( "col-" + token + "-push-" + width );
		}

		@Override
		public boolean equals( Object o ) {
			if ( this == o ) {
				return true;
			}
			if ( o == null || getClass() != o.getClass() ) {
				return false;
			}
			Column column = (Column) o;
			return Objects.equals( width, column.width ) &&
					Objects.equals( token, column.token );
		}

		@Override
		public int hashCode() {
			return Objects.hash( token, width );
		}

		@Override
		public String toString() {
			return asWidth().toString();
		}
	}

	public static class Position extends ArrayList
	{
		public Position() {
			super( 4 );
		}

		/**
		 * Convert all column positions to an offset. Ignores all others.
		 */
		public Position asOffset() {
			Position position = new Position();

			for ( DeviceGridLayout layout : this ) {
				if ( layout instanceof Column ) {
					position.add( ( (Column) layout ).asOffset() );
				}
			}

			return position;
		}

		@Override
		public String toString() {
			List strings = new ArrayList<>( size() );
			for ( DeviceGridLayout action : this ) {
				strings.add( action.toString() );
			}

			return StringUtils.join( strings, " " );
		}
	}

	public Grid() {
		super( Width.FULL );
	}

	@Override
	public String toString() {
		List strings = new ArrayList<>( size() );
		for ( Position position : this ) {
			strings.add( "[" + position.toString() + "]" );
		}

		return "Grid{" + StringUtils.join( strings, "," ) + "}";
	}

	/**
	 * Create a simple grid with the number of columns specified by the width parameter values.
	 * Columns will only have values registered for {@link Device#MD}.
	 *
	 * @param widths for the columns
	 * @return grid
	 */
	public static Grid create( int... widths ) {
		Grid grid = new Grid();
		Arrays.stream( widths ).forEach( w -> grid.add( position( Device.MD.width( w ) ) ) );
		return grid;
	}

	public static Grid create( Position... positions ) {
		Grid grid = new Grid();
		Collections.addAll( grid, positions );
		return grid;
	}

	public static Position position( DeviceGridLayout... layouts ) {
		Position position = new Position();
		Collections.addAll( position, layouts );

		return position;
	}
}