de.agilecoders.wicket.sass.SassResourceReference Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wicket-bootstrap-sass Show documentation
The newest version!
package de.agilecoders.wicket.sass;

import org.apache.wicket.request.resource.CssResourceReference;

import java.util.Locale;

/**
 * A resource reference for SASS resources.
 * The resources are filtered (stripped comments and whitespace) if there is registered compressor.
 *
 * Supported path schemes for SASS {@code @import} directive are:
 *
 * 

 *   Direct e.g. {@code @import "child.scss";} the imported file must be in the same package and JAR.
 *   Absolute classpath e.g. {@code @import "classpath!/com/soluvas/web/child.scss";} the imported file can be in any JAR but must be in specified package.
 *   Relative classpath e.g. {@code @import "package!child.scss";} the imported file can be in any JAR but must be accessible relative to the {@code scope} given to {@code SassResourceReference}.
 *   WebJar e.g. {@code @import "webjars!bootstrap/current/scss/variables.scss";} (current version) or {@code @import "webjars!bootstrap/3.2.0/scss/variables.scss";} (specific version).
 * 
 *
 * @author miha
 * @see org.apache.wicket.settings.ResourceSettings#getCssCompressor()
 */
public class SassResourceReference extends CssResourceReference {
    private static final long serialVersionUID = 1L;

    /**
     * Construct.
     *
     * @param scope mandatory parameter
     * @param name  mandatory parameter
     */
    public SassResourceReference(final Class scope, final String name) {
        this(scope, name, null, null, null);
    }


    /**
     * Construct.
     *
     * @param key  mandatory parameter
     */
    public SassResourceReference(final Key key) {
        super(key);
    }

    /**
     * Construct.
     *
     * @param scope  mandatory parameter
     * @param name   mandatory parameter
     * @param locale resource locale
     * @param style  resource style
     */
    public SassResourceReference(final Class scope, final String name, final Locale locale, final String style, final String variation) {
        super(scope, name, locale, style, variation);
    }

    @Override
    public SassPackageResource getResource() {
        return new SassPackageResource(getScope(), getName(), getLocale(), getStyle(), getVariation());
    }
}