com.alee.extended.svg.SvgSelector Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of weblaf-ui Show documentation
WebLaF UI components
There is a newer version: 1.2.14
/*
 * This file is part of WebLookAndFeel library.
 *
 * WebLookAndFeel library 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.
 *
 * WebLookAndFeel library 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 WebLookAndFeel library.  If not, see .
 */

package com.alee.extended.svg;

import com.alee.api.annotations.NotNull;
import com.alee.api.jdk.Objects;
import com.alee.utils.CollectionUtils;
import com.alee.utils.TextUtils;
import com.alee.utils.collection.ImmutableSet;
import com.kitfox.svg.SVGElement;
import com.kitfox.svg.xml.StyleAttribute;

import java.io.Serializable;
import java.util.List;
import java.util.Locale;
import java.util.Set;

/**
 * Special object that parses {@link SvgIcon} selectors and performs lookup.
 * Here are a few examples of its usage:
 *
 * 1. Element by its ID, example: {@code "#id"}
 * All SVG elements with the specified ID selected.
 *
 * 2. Element by its class, example: {@code ".name"}
 * All SVG elements with the specified class name selected.
 *
 * 3. Element by its name, example: {@code "svg"}, {@code "path"}
 * All SVG elements of the specified type selected.
 *
 * 4. All elements, example: {@code "*"}
 * All SVG elements selected.
 *
 * 5. By attributes, example: {@code "[stroke]"}, {@code "*[fill]"}, {@code ".name[stroke,fill,transform]"}
 * Can be used as standalone selector - in that case all SVG elements will be checked (equal to {@code "*"} element selector).
 * Can be used in addition to one of previously mentioned selectors - that will limit SVG elements to be checked.
 *
 * @author Mikle Garin
 * @see SvgIcon
 * @see SvgElements
 */
public class SvgSelector implements Serializable
{
    /**
     * Opening brace for attribute conditions.
     */
    protected static final String OPEN_BRACE = "[";

    /**
     * Closing brace for attribute conditions.
     */
    protected static final String CLOSE_BRACE = "]";

    /**
     * Attribute conditions separator.
     */
    protected static final String ATTRIBUTE_SEPARATOR = ",";

    /**
     * Element selector.
     */
    @NotNull
    protected final String element;

    /**
     * Element attribute filter.
     */
    @NotNull
    protected final Set attributes;

    /**
     * Constructs new {@link SvgSelector} based on its text representation.
     *
     * @param selector {@link String} representation of {@link SvgSelector}
     */
    public SvgSelector ( @NotNull final String selector )
    {
        // Checking raw selector
        if ( TextUtils.isEmpty ( selector ) )
        {
            final String msg = "SVG element selector cannot be empty";
            throw new RuntimeException ( msg );
        }

        // Checking syntax
        final int openBrace = selector.indexOf ( OPEN_BRACE );
        final int closeBrace = selector.indexOf ( CLOSE_BRACE );
        if ( openBrace != -1 && closeBrace == -1 || openBrace == -1 && closeBrace != -1 )
        {
            final String msg = "Incorrect attributes selector syntax";
            throw new RuntimeException ( msg );
        }

        // Parsing selector
        final String rawElement = openBrace != -1 ? selector.substring ( 0, openBrace ) : selector;
        this.element = rawElement.trim ().toLowerCase ( Locale.ROOT );

        // Parsing extra information
        final String bracedText = openBrace != -1 ? selector.substring ( openBrace + OPEN_BRACE.length (), closeBrace ) : null;
        final List conditions = TextUtils.stringToList ( bracedText, ATTRIBUTE_SEPARATOR );
        this.attributes = new ImmutableSet ( conditions );
    }

    /**
     * Returns whether or not specified {@link SVGElement} matches this {@link SvgSelector} conditions.
     *
     * @param icon    {@link SvgIcon} icon to check element
     * @param element {@link SVGElement}
     * @return {@code true} if specified {@link SVGElement} matches this {@link SvgSelector} conditions, {@code false} otherwise
     */
    public boolean isApplicable ( @NotNull final SvgIcon icon, @NotNull final SVGElement element )
    {
        return checkSelector ( icon, element ) && checkAttributes ( icon, element );
    }

    /**
     * Returns whether or not specified {@link SVGElement} matches this {@link SvgSelector} conditions.
     *
     * @param icon    {@link SvgIcon} icon to check element
     * @param element {@link SVGElement}
     * @return {@code true} if specified {@link SVGElement} matches this {@link SvgSelector} conditions, {@code false} otherwise
     */
    protected boolean checkSelector ( @NotNull final SvgIcon icon, @NotNull final SVGElement element )
    {
        final boolean match;
        if ( TextUtils.isEmpty ( this.element ) || this.element.equals ( "*" ) )
        {
            match = true;
        }
        else if ( this.element.startsWith ( "#" ) )
        {
            final String id = this.element.substring ( 1 );
            final StyleAttribute attribute = icon.getAttribute ( element, SvgElements.ID );
            match = attribute != null && Objects.equals ( id, attribute.getStringValue () );
        }
        else if ( this.element.startsWith ( "." ) )
        {
            final String style = this.element.substring ( 1 );
            final StyleAttribute attribute = icon.getAttribute ( element, SvgElements.CLASS );
            match = attribute != null && Objects.equals ( style, attribute.getStringValue () );
        }
        else
        {
            match = element.getClass () == SvgElements.CLASSES.get ( this.element );
        }
        return match;
    }

    /**
     * Returns whether or not specified {@link SVGElement} matches this {@link SvgSelector} attribute conditions.
     *
     * @param icon    {@link SvgIcon} icon to check element
     * @param element {@link SVGElement}
     * @return {@code true} if specified {@link SVGElement} matches this {@link SvgSelector} attribute conditions, {@code false} otherwise
     */
    protected boolean checkAttributes ( @NotNull final SvgIcon icon, @NotNull final SVGElement element )
    {
        boolean hasAttributes;
        if ( CollectionUtils.notEmpty ( attributes ) )
        {
            hasAttributes = false;
            for ( final String attribute : attributes )
            {
                if ( icon.hasAttribute ( element, attribute ) )
                {
                    hasAttributes = true;
                    break;
                }
            }
        }
        else
        {
            hasAttributes = true;
        }
        return hasAttributes;
    }
}