com.helger.pdflayout.spec.BorderSpec Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-pdf-layout Show documentation
Show all versions of ph-pdf-layout Show documentation
Library for creating nicely layouted PDF documents based on PDFBox
/**
* Copyright (C) 2014-2016 Philip Helger (www.helger.com)
* philip[at]helger[dot]com
*
* 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.helger.pdflayout.spec;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import com.helger.commons.annotation.MustImplementEqualsAndHashcode;
import com.helger.commons.equals.EqualsHelper;
import com.helger.commons.hashcode.HashCodeGenerator;
import com.helger.commons.string.ToStringGenerator;
/**
* This class represents a border around a single element. Each side can be
* styled separately.
*
* @author Philip Helger
*/
@Immutable
@MustImplementEqualsAndHashcode
public class BorderSpec
{
/** Represents no border at all! */
public static final BorderSpec BORDER0 = new BorderSpec (null);
private final BorderStyleSpec m_aTop;
private final BorderStyleSpec m_aRight;
private final BorderStyleSpec m_aBottom;
private final BorderStyleSpec m_aLeft;
/**
* Constructor.
*
* @param aBorder
* The border to set for all sides (left, top, right, bottom). Maybe
* null.
*/
public BorderSpec (@Nullable final BorderStyleSpec aBorder)
{
this (aBorder, aBorder);
}
/**
* Constructor.
*
* @param aBorderY
* The border to set for top and bottom. Maybe null.
* @param aBorderX
* The border to set for left and right. Maybe null.
*/
public BorderSpec (@Nullable final BorderStyleSpec aBorderY, @Nullable final BorderStyleSpec aBorderX)
{
this (aBorderY, aBorderX, aBorderY, aBorderX);
}
/**
* Constructor.
*
* @param aBorderTop
* The border to set for top. Maybe null.
* @param aBorderRight
* The border to set for right. Maybe null.
* @param aBorderBottom
* The border to set for bottom. Maybe null.
* @param aBorderLeft
* The border to set for left. Maybe null.
*/
public BorderSpec (@Nullable final BorderStyleSpec aBorderTop,
@Nullable final BorderStyleSpec aBorderRight,
@Nullable final BorderStyleSpec aBorderBottom,
@Nullable final BorderStyleSpec aBorderLeft)
{
m_aLeft = aBorderLeft;
m_aTop = aBorderTop;
m_aRight = aBorderRight;
m_aBottom = aBorderBottom;
}
/**
* @return true if all borders are defined, false
* otherwise.
*/
public boolean hasAllBorders ()
{
return m_aTop != null && m_aRight != null && m_aBottom != null && m_aLeft != null;
}
/**
* @return true if at least one border is defined,
* false if no border is defined at all.
*/
public boolean hasAnyBorder ()
{
return m_aTop != null || m_aRight != null || m_aBottom != null || m_aLeft != null;
}
/**
* @return true if all border sides are equal. This is
* true for null borders as well as for
* defined borders.
*/
public boolean areAllBordersEqual ()
{
return EqualsHelper.equals (m_aLeft, m_aTop) &&
EqualsHelper.equals (m_aLeft, m_aRight) &&
EqualsHelper.equals (m_aLeft, m_aBottom);
}
/**
* @return The top border style. May be null.
*/
@Nullable
public BorderStyleSpec getTop ()
{
return m_aTop;
}
/**
* @return The right border style. May be null.
*/
@Nullable
public BorderStyleSpec getRight ()
{
return m_aRight;
}
/**
* @return The bottom border style. May be null.
*/
@Nullable
public BorderStyleSpec getBottom ()
{
return m_aBottom;
}
/**
* @return The left border style. May be null.
*/
@Nullable
public BorderStyleSpec getLeft ()
{
return m_aLeft;
}
/**
* @return The top border width.
*/
public float getTopWidth ()
{
final BorderStyleSpec aBSS = m_aTop;
return aBSS == null ? 0 : aBSS.getLineWidth ();
}
/**
* @return The right border width.
*/
public float getRightWidth ()
{
final BorderStyleSpec aBSS = m_aRight;
return aBSS == null ? 0 : aBSS.getLineWidth ();
}
/**
* @return The bottom border width.
*/
public float getBottomWidth ()
{
final BorderStyleSpec aBSS = m_aBottom;
return aBSS == null ? 0 : aBSS.getLineWidth ();
}
/**
* @return The left border width.
*/
public float getLeftWidth ()
{
final BorderStyleSpec aBSS = m_aLeft;
return aBSS == null ? 0 : aBSS.getLineWidth ();
}
/**
* @return The sum of left and right border width.
*/
public float getXSumWidth ()
{
return getLeftWidth () + getRightWidth ();
}
/**
* @return The sum of left and right border width.
*/
public float getYSumWidth ()
{
return getTopWidth () + getBottomWidth ();
}
@Nonnull
public BorderSpec getCloneWithTop (@Nullable final BorderStyleSpec aTop)
{
if (EqualsHelper.equals (aTop, m_aTop))
return this;
return new BorderSpec (aTop, m_aRight, m_aBottom, m_aLeft);
}
@Nonnull
public BorderSpec getCloneWithRight (@Nullable final BorderStyleSpec aRight)
{
if (EqualsHelper.equals (aRight, m_aRight))
return this;
return new BorderSpec (m_aTop, aRight, m_aBottom, m_aLeft);
}
@Nonnull
public BorderSpec getCloneWithBottom (@Nullable final BorderStyleSpec aBottom)
{
if (EqualsHelper.equals (aBottom, m_aBottom))
return this;
return new BorderSpec (m_aTop, m_aRight, aBottom, m_aLeft);
}
@Nonnull
public BorderSpec getCloneWithLeft (@Nullable final BorderStyleSpec aLeft)
{
if (EqualsHelper.equals (aLeft, m_aLeft))
return this;
return new BorderSpec (m_aTop, m_aRight, m_aBottom, aLeft);
}
@Override
public boolean equals (final Object o)
{
if (this == o)
return true;
if (o == null || !getClass ().equals (o.getClass ()))
return false;
final BorderSpec rhs = (BorderSpec) o;
return EqualsHelper.equals (m_aTop, rhs.m_aTop) &&
EqualsHelper.equals (m_aRight, rhs.m_aRight) &&
EqualsHelper.equals (m_aBottom, rhs.m_aBottom) &&
EqualsHelper.equals (m_aLeft, rhs.m_aLeft);
}
@Override
public int hashCode ()
{
return new HashCodeGenerator (this).append (m_aTop)
.append (m_aRight)
.append (m_aBottom)
.append (m_aLeft)
.getHashCode ();
}
@Override
public String toString ()
{
return new ToStringGenerator (this).appendIfNotNull ("left", m_aLeft)
.appendIfNotNull ("top", m_aTop)
.appendIfNotNull ("right", m_aRight)
.appendIfNotNull ("bottom", m_aBottom)
.toString ();
}
}