com.webfirmframework.wffweb.css.css3.ColumnGap Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of wffweb Show documentation
Show all versions of wffweb Show documentation
A java framework to develop web applications
/*
* Copyright 2014-2016 Web Firm Framework
*
* 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.
* @author WFF
*/
package com.webfirmframework.wffweb.css.css3;
import java.util.Arrays;
import java.util.List;
import com.webfirmframework.wffweb.InvalidValueException;
import com.webfirmframework.wffweb.NullValueException;
import com.webfirmframework.wffweb.css.CssLengthUnit;
import com.webfirmframework.wffweb.css.CssNameConstants;
import com.webfirmframework.wffweb.css.core.AbstractCssProperty;
/**
*
* The column-gap property specifies the gap between the columns.
*
* Note: If there is a column-rule between columns, it will appear in the middle of the gap.
* Default value: normal
* Inherited: no
* Animatable: yes
* Version: CSS3
* JavaScript syntax: object.style.columnGap="50px"
*
*
* @author WFF
* @since 1.0.0
*/
public class ColumnGap extends AbstractCssProperty {
private static final long serialVersionUID = 1_0_0L;
public static final String NORMAL = "normal";
public static final String INITIAL = "initial";
public static final String INHERIT = "inherit";
private static final List PREDEFINED_CONSTANTS = Arrays
.asList(INITIAL, INHERIT, NORMAL);
private String cssValue;
private Float value;
private CssLengthUnit cssLengthUnit;
/**
* The {@code normal} will be set as the value
*/
public ColumnGap() {
setCssValue(NORMAL);
}
/**
* @param cssValue
* the css value to set.
*/
public ColumnGap(final String cssValue) {
setCssValue(cssValue);
}
/**
* @param columnGap
* the {@code ColumnGap} object from which the cssValue to
* set.And, {@code null} will throw {@code NullValueException}
*/
public ColumnGap(final ColumnGap columnGap) {
if (columnGap == null) {
throw new NullValueException("columnGap can not be null");
}
setCssValue(columnGap.getCssValue());
}
/**
* @param percent
* the percentage value to set. The cssLengthUnit will
* automatically set to %.
* @since 1.0.0
* @author WFF
*/
public ColumnGap(final float percent) {
cssLengthUnit = CssLengthUnit.PER;
value = percent;
cssValue = percent + "" + cssLengthUnit;
}
/**
* @param value
* @param cssLengthUnit
*/
public ColumnGap(final float value, final CssLengthUnit cssLengthUnit) {
this.value = value;
this.cssLengthUnit = cssLengthUnit;
cssValue = value + "" + cssLengthUnit;
}
/**
* @param value
* @param cssLengthUnit
* @return the current object
* @since 1.0.0
* @author WFF
*/
public ColumnGap setValue(final float value,
final CssLengthUnit cssLengthUnit) {
this.value = value;
this.cssLengthUnit = cssLengthUnit;
cssValue = value + "" + cssLengthUnit;
if (getStateChangeInformer() != null) {
getStateChangeInformer().stateChanged(this);
}
return this;
}
/**
* @param percent
* the percent to set
* @since 1.0.0
* @author WFF
*/
public void setPercent(final float percent) {
value = percent;
cssLengthUnit = CssLengthUnit.PER;
cssValue = percent + "" + cssLengthUnit;
if (getStateChangeInformer() != null) {
getStateChangeInformer().stateChanged(this);
}
}
/*
* (non-Javadoc)
*
* @see com.webfirmframework.wffweb.css.CssProperty#getCssName()
*
* @since 1.0.0
*
* @author WFF
*/
@Override
public String getCssName() {
return CssNameConstants.COLUMN_GAP;
}
/*
* (non-Javadoc)
*
* @see com.webfirmframework.wffweb.css.CssProperty#getCssValue()
*
* @since 1.0.0
*
* @author WFF
*/
@Override
public String getCssValue() {
return cssValue;
}
@Override
public String toString() {
return getCssName() + ": " + getCssValue();
}
/**
* gets the width in float value. {@code ColumnGap#getUnit()} should be used
* to get the cssLengthUnit for this value.
*
* @return the value in float or null if the cssValue is
* initial or inherit.
* @since 1.0.0
* @author WFF
*/
public Float getValue() {
return value;
}
/**
* @return the cssLengthUnit {@code PX}/{@code PER}, or {@code null} if the
* value is any inbuilt value like {@code inherit}.
* @since 1.0.0
* @author WFF
*/
public CssLengthUnit getUnit() {
return cssLengthUnit;
}
/**
* @param cssValue
* the value should be in the format of 55px or
* 95%. {@code null} is considered as an invalid
* value and it will throw {@code NullValueException}.
* @since 1.0.0
* @author WFF
*/
@Override
public ColumnGap setCssValue(final String cssValue) {
try {
if (cssValue == null) {
throw new NullValueException(
"null is an invalid value. The value format should be as for example 75px or 85%. Or, initial/inherit.");
} else {
final String trimmedCssValue = cssValue.trim();
boolean invalidValue = true;
for (final CssLengthUnit cssLengthUnit : CssLengthUnit
.values()) {
final String unit = cssLengthUnit.getUnit();
if (trimmedCssValue.endsWith(unit)) {
final String valueOnly = trimmedCssValue
.replaceFirst(unit, "");
try {
value = Float.parseFloat(valueOnly);
} catch (final NumberFormatException e) {
break;
}
this.cssLengthUnit = cssLengthUnit;
this.cssValue = cssValue;
invalidValue = false;
break;
}
}
if (trimmedCssValue.equalsIgnoreCase(INITIAL)
|| trimmedCssValue.equalsIgnoreCase(INHERIT)
|| trimmedCssValue.equalsIgnoreCase(NORMAL)) {
this.cssValue = trimmedCssValue.toLowerCase();
cssLengthUnit = null;
value = null;
invalidValue = false;
}
if (invalidValue) {
throw new InvalidValueException(cssValue
+ " is an invalid value. The value format should be as for example 75px, 85%, initial, inherit etc..");
}
}
if (getStateChangeInformer() != null) {
getStateChangeInformer().stateChanged(this);
}
} catch (final NumberFormatException e) {
throw new InvalidValueException(
cssValue + " is an invalid value. The value format should be as for example 75px or 85%. Or, initial/inherit.",
e);
}
return this;
}
/**
* sets as {@code initial}
*
* @since 1.0.0
* @author WFF
*/
public void setAsInitial() {
setCssValue(INITIAL);
}
/**
* sets as {@code inherit}
*
* @since 1.0.0
* @author WFF
*/
public void setAsInherit() {
setCssValue(INHERIT);
}
/**
* sets as {@code normal}.
*
* @since 1.0.0
* @author WFF
*/
public void setAsNormal() {
setCssValue(NORMAL);
}
/**
* validates if the given cssValue is valid for this class.
*
* @param cssValue
* the value to check.
* @return true if valid and false if invalid.
* @author WFF
* @since 1.0.0
*/
public static boolean isValid(final String cssValue) {
final String trimmedCssValue = cssValue.trim().toLowerCase();
if (trimmedCssValue.contains(" ")) {
return false;
}
for (final CssLengthUnit cssLengthUnit : CssLengthUnit.values()) {
final String unit = cssLengthUnit.getUnit();
if (trimmedCssValue.endsWith(unit)) {
final String valueOnly = trimmedCssValue.replaceFirst(unit, "");
try {
Float.parseFloat(valueOnly);
} catch (final NumberFormatException e) {
break;
}
return true;
}
}
return PREDEFINED_CONSTANTS.contains(trimmedCssValue);
}
}