All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javafx.css.Selector Maven / Gradle / Ivy

There is a newer version: 24-ea+15
Show newest version
/*
 * Copyright (c) 2008, 2023, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code 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
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javafx.css;

import com.sun.javafx.css.Combinator;

import java.io.DataInputStream;
import java.io.DataOutputStream;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;

/**
 * Used by {@code CSSRule} to determine whether or not the {@code Selector} applies to a
 * given object.
 *
 * @since 9
 */
abstract public class Selector {

    /**
     * Package scoped constructor.
     */
    Selector() {
    }

    private static class UniversalSelector {
        private static final Selector INSTANCE =
            new SimpleSelector("*", null, null, null);
    }

    static Selector getUniversalSelector() {
        return UniversalSelector.INSTANCE;
    }

    private Rule rule;
    /**
     * Sets the {@code Rule} of this Selector.
     * @param rule the {@code Rule} of this Selector
     */
    void setRule(Rule rule) {
        this.rule = rule;
    }

    /**
     * Gets the {@code Rule} of this Selector.
     * @return rule
     */
    public Rule getRule() {
        return rule;
    }

    private int ordinal = -1;
    /**
     * Sets the ordinal of this Selector.
     * @param ordinal the ordinal of this Selector
     */
    public void setOrdinal(int ordinal) {
        this.ordinal = ordinal;
    }

    /**
     * Gets the ordinal of this Selector.
     * @return the ordinal of this Selector
     */
    public int getOrdinal() {
        return ordinal;
    }

    /**
     * Creates a {@code Match}.
     *
     * @return a match, never {@code null}
     */
    public abstract Match createMatch();

    /**
     * Gets whether this {@code Selector} applies to the given {@code Styleable}.
     * @param styleable the {@code Styleable} to match
     * @return {@code true} if this {@code Selector} applies to the given {@code Styleable}
     */
    public abstract boolean applies(Styleable styleable);

    /**
     * Gets whether this {@code Selector} applies to the given {@code Styleable}.
     * It is the same as the {@link applies(Styleable)} method except it also returns
     * {@code PseudoClass} state that it finds along the way.
     * @param styleable the {@code Styleable} to match
     * @param triggerStates a set of {@code PseudoClass} states
     * @param depth depth of the {@code Node} heirarchy to look for
     * @return {@code true} if this {@code Selector} and a set of {@code PseudoClass}
     * applies to the given {@code Styleable}
     */
    public abstract boolean applies(Styleable styleable, Set[] triggerStates, int depth);

    /**
     * Determines whether the current state of the {@code Node} and its parents
     * matches the pseudo-classes defined (if any) for this selector.
     * @param styleable the styleable
     * @param state the state
     * @return {@code true} if the current state of the node and its parents
     * matches the pseudo-classes defined (if any) for this selector
     */
    public abstract boolean stateMatches(Styleable styleable, Set state);

    private static final int TYPE_SIMPLE = 1;
    private static final int TYPE_COMPOUND = 2;

    /**
     * Writes {@code Selector} data in binary form to given {@code DataOutputStream}.
     * @param os {@code DataOutputStream} to write {@code Selector} data to
     * @param stringStore unused
     * @throws IOException if writing to {@code DataOutputStream} fails
     */
    protected void writeBinary(DataOutputStream os, StyleConverter.StringStore stringStore)
        throws IOException {
        if (this instanceof SimpleSelector) {
            os.writeByte(TYPE_SIMPLE);
        } else {
            os.writeByte(TYPE_COMPOUND);
        }
    }

    /**
     * Reads binary {@code Selector} data from a given {@code DataInputStream}.
     * @param bssVersion bss version identifier
     * @param is {@code DataInputStream} to read {@code Selector} data from
     * @param strings string array containing selector details
     * @throws IOException if reading from {@code DataInputStream} fails
     */
    static Selector readBinary(int bssVersion, DataInputStream is, String[] strings)
        throws IOException {
        final int type = is.readByte();
        if (type == TYPE_SIMPLE)
            return SimpleSelector.readBinary(bssVersion, is,strings);
        else
            return CompoundSelector.readBinary(bssVersion, is,strings);
    }

    /**
     * Creates a {@code Selector} object.
     * @param cssSelector CSS selector string
     * @return a {@code Selector}
     */
    public static Selector createSelector(final String cssSelector) {
        if (cssSelector == null || cssSelector.length() == 0) {
            return null; // actually return a default no-match selector
        }

        // A very primitive parser
        List selectors = new ArrayList<>();
        List combinators = new ArrayList<>();
        List parts = new ArrayList<>();
        int start = 0;
        int end = -1;
        char combinator = '\0';
        for (int i=0; i') {
                if (combinator == '\0') end = i;
                combinator = ch;
            } else if (combinator != '\0'){
                parts.add(cssSelector.substring(start, end));
                start = i;
                combinators.add(combinator == ' ' ? Combinator.DESCENDANT : Combinator.CHILD);
                combinator = '\0';
            }
        }
        parts.add(cssSelector.substring(start));

        for (int i=0; i pseudoClasses = new ArrayList<>();
                for (int j=1; j styleClasses = new ArrayList<>();

                // If the first one is an empty string, then it started with a pseudo class
                // If the first one starts with a #, it was an id
                // Otherwise, it was a name
                for (int j=1; j




© 2015 - 2024 Weber Informatics LLC | Privacy Policy