com.jwebmp.plugins.bootstrap.carousel.BSCarouselControl 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.carousel;

import com.jwebmp.core.base.html.Link;
import com.jwebmp.core.base.html.Span;
import com.jwebmp.core.base.html.attributes.LinkAttributes;

import java.util.Objects;

/**
 * Defines a control for the bootstrap carousel
 *
 * @author GedMarc
 * @version 1.0
 * @since 01 Jan 2017
 */
public class BSCarouselControl
		extends Link
		implements BSCarouselChildren
{

	private static final long serialVersionUID = 1L;
	/**
	 * The actual carousel
	 */
	private BSCarousel carousel;
	/**
	 * If this is a previous control, as opposed to next
	 */
	private boolean previous;
	/**
	 * The icon for this control, automatically gets next and previous added on
	 */
	private Span icon;

	/**
	 * Constructs with a carousel and a previous
	 *
	 * @param carousel
	 * @param previous
	 */
	public BSCarouselControl(BSCarousel carousel, boolean previous)
	{
		this.carousel = carousel;

		addAttribute("role", "button");

		if (previous)
		{
			addAttribute("data-slide", "prev");
		}
		else
		{
			addAttribute("data-slide", "next");
		}
		if (carousel != null)
		{
			addAttribute(LinkAttributes.HRef, carousel.getID(true));
		}
	}

	/**
	 * Returns the carousel
	 *
	 * @return
	 */
	public BSCarousel getCarousel()
	{
		if (carousel == null)
		{
			setCarousel(new BSCarousel());
		}
		return carousel;
	}

	/**
	 * Set carousel
	 *
	 * @param carousel
	 *
	 * @return
	 */
	public BSCarouselControl setCarousel(BSCarousel carousel)
	{
		this.carousel = carousel;
		return this;
	}

	/**
	 * Returns if this is a previous or next item
	 *
	 * @return
	 */
	public boolean isPrevious()
	{
		return previous;
	}

	/**
	 * Sets if this is a previous or next control
	 *
	 * @param previous
	 *
	 * @return
	 */
	public BSCarouselControl setPrevious(boolean previous)
	{
		this.previous = previous;
		return this;
	}

	@Override
	public boolean equals(Object o)
	{
		if (this == o)
		{
			return true;
		}
		if (!(o instanceof BSCarouselControl))
		{
			return false;
		}
		if (!super.equals(o))
		{
			return false;
		}
		BSCarouselControl that = (BSCarouselControl) o;
		return Objects.equals(getComponent(), that.getComponent());
	}

	@Override
	public int hashCode()
	{
		return Objects.hash(super.hashCode(), getIcon());
	}

	/**
	 * Returns the span for the icon, auto generated if need be
	 *
	 * @return
	 */
	public Span getIcon()
	{
		return icon;
	}

	/**
	 * Sets the icon to the given item
	 *
	 * @param icon
	 *
	 * @return
	 */
	public BSCarouselControl setIcon(Span icon)
	{
		this.icon = icon;

		return this;
	}
}