com.webfirmframework.wffweb.css.css3.Opacity Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wffweb Show documentation
A java framework to develop web applications
There is a newer version: 12.0.1
/*
 * Copyright 2014-2020 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.CssNameConstants;
import com.webfirmframework.wffweb.css.core.AbstractCssProperty;
import com.webfirmframework.wffweb.util.StringUtil;
import com.webfirmframework.wffweb.util.TagStringUtil;

/**
 *  * opacity: number|initial|inherit;
 *
 * The opacity property sets the opacity level for an element.
 *
 * The opacity-level describes the transparency-level, where 1 is not transparant at all, 0.5 is 50% see-through, and 0 is completely transparent.
 * Default value:  1
 * Inherited:      no
 * Animatable:     yes
 * Version:        CSS3
 * JavaScript syntax:      object.style.opacity="0.5"
 * 
 *
 * @author WFF
 * @since 1.0.0
 */
public class Opacity extends AbstractCssProperty {

    private static final long serialVersionUID = 1_0_0L;

    public static final String INITIAL = "initial";
    public static final String INHERIT = "inherit";

    private static final List PREDEFINED_CONSTANTS = Arrays.asList(INITIAL, INHERIT);

    private String cssValue;
    private Float value;

    /**
     * The default value 1 will be set as the cssValue.
     *
     * @author WFF
     * @since 1.0.0
     */
    public Opacity() {
        value = Float.valueOf(1F);
        cssValue = value.toString();
    }

    /**
     * @param cssValue the css value to set.
     */
    public Opacity(final String cssValue) {
        setCssValue(cssValue);
    }

    /**
     * @param opacity the {@code Opacity} object from which the cssValue to set.And,
     *                {@code null} will throw {@code NullValueException}
     */
    public Opacity(final Opacity opacity) {
        if (opacity == null) {
            throw new NullValueException("opacity can not be null");
        }
        setCssValue(opacity.getCssValue());
    }

    /**
     * @param value
     */
    public Opacity(final float value) {
        if (value > 1 || value < 0) {
            throw new InvalidValueException("the value should be in between 0 to 1.");
        }
        this.value = value;
        cssValue = String.valueOf(value);
    }

    /*
     * (non-Javadoc)
     *
     * @see com.webfirmframework.wffweb.css.CssProperty#getCssName()
     *
     * @since 1.0.0
     *
     * @author WFF
     */
    @Override
    public String getCssName() {
        return CssNameConstants.OPACITY;
    }

    /*
     * (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 opacity in {@code Float} 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;
    }

    /**
     * @param value the value to set
     * @author WFF
     * @since 1.0.0
     */
    public void setValue(final float value) {
        if (value > 1 || value < 0) {
            throw new InvalidValueException("the value should be in between 0 to 1.");
        }
        this.value = value;
        cssValue = String.valueOf(value);
        if (getStateChangeInformer() != null) {
            getStateChangeInformer().stateChanged(this);
        }
    }

    /**
     * @param cssValue the value should be in the format of 0.5,
     *                 initial/inherit. {@code null} is considered as
     *                 an invalid value and it will throw
     *                 {@code NullValueException}.
     * @since 1.0.0
     * @author WFF
     */
    @Override
    public Opacity setCssValue(final String cssValue) {
        if (cssValue == null) {
            throw new NullValueException(
                    "null is an invalid value. The value format should be as for example 0.5, initial/inherit.");
        } else {

            final String trimmedCssValue = TagStringUtil.toLowerCase(StringUtil.strip(cssValue));

            if (INITIAL.equals(trimmedCssValue) || INHERIT.equals(trimmedCssValue)) {
                this.cssValue = trimmedCssValue;
                value = null;
            } else {
                try {
                    final float tempValue = Float.valueOf(trimmedCssValue);
                    if (tempValue < 0 || tempValue > 1) {
                        throw new InvalidValueException("The cssValue should be a number in between 0 to 1.");
                    }
                    value = tempValue;
                    this.cssValue = value.toString();
                } catch (final NumberFormatException e) {
                    throw new InvalidValueException(cssValue
                            + " is an invalid value. The value format should be as for example 0.5, initial, inherit etc..");
                }
            }

        }
        if (getStateChangeInformer() != null) {
            getStateChangeInformer().stateChanged(this);
        }
        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);
    }

    /**
     * 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 = TagStringUtil.toLowerCase(StringUtil.strip(cssValue));
        if (StringUtil.containsSpace(trimmedCssValue)) {
            return false;
        }
        try {

            final float parsedValue = Float.parseFloat(trimmedCssValue);

            if (parsedValue < 0 || parsedValue > 1) {
                return false;
            }

            return !(parsedValue == 0
                    && (StringUtil.containsMinus(trimmedCssValue) || StringUtil.containsPlus(trimmedCssValue)));
        } catch (final NumberFormatException e) {
        }

        return PREDEFINED_CONSTANTS.contains(trimmedCssValue);
    }
}