org.wicketstuff.jwicket.JQueryResourceReference Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wicketstuff-jwicket-core Show documentation

WicketJQuery by Stefan Lindner has been renamed to jWicket, mavenized, and migrated to WicketStuff. This Wicketstuff version supercedes the original version which was available at http://subversion.visionet.de/project/WicketJQuery/wiki

There is a newer version: 9.7.0

Show newest version

package org.wicketstuff.jwicket;


import org.apache.wicket.WicketRuntimeException;
import org.apache.wicket.request.resource.JavaScriptResourceReference;
import org.apache.wicket.util.time.Time;
import org.apache.wicket.util.watch.IModifiable;


/**
 * Base class for all Header contributing resource references.
 * The resource references are divided into two main categories:
 * Resources that must not be modified by the user
 * of this jQuery-Wicket library. This are e.g.
 * libraries that are patches/modified to work around
 * some speical problems. If this libraries would have
 * been replaced by the user, the functionality of of
 * this lirary will definitely be broken.
 * Resources that maybe replaced by the user.
 * 
 * 
 * If you write your own module for this library you may need to use
 * e.g. the newest ui-core.js version. Then you can provide your own
 * version of the js library and it overrides the internal one because
 * ui-core.js is marked as {@link JQueryResourceReferenceType#OVERRIDABLE}.
 * 

 * If you try to replace the core jQuery.js library itself, this may
 * have no effect as the library may be marked as
 * {@link JQueryResourceReferenceType#NOT_OVERRIDABLE}. This is because
 * jQuery.js contains some special patches at the moment. This may
 * change in future versions of this library if the jQuery developers fix
 * some problems in the official release.
 * 
 * If you try to replace any library that is marked as
 * {@link JQueryResourceReferenceType#NOT_OVERRIDABLE} with your own version
 * this will lead to a {@link WicketRuntimeException}.
 */
public class JQueryResourceReference extends JavaScriptResourceReference implements IModifiable {

    private static final long serialVersionUID = 1L;

    private final JQueryResourceReferenceType type;
    private String id = null;

    public JQueryResourceReference(final Class scope, final String name) {
        this(scope, name, (String) null);
    }

    public JQueryResourceReference(final Class scope, final String name, final String id) {
        this(scope, name, id, JQueryResourceReferenceType.OVERRIDABLE);
    }

    public JQueryResourceReference(final Class scope, final String name, final JQueryResourceReferenceType type) {
        this(scope, name, null, type);
    }

    public JQueryResourceReference(final Class scope, final String name, final String id, final JQueryResourceReferenceType type) {
        super(scope, name);
        this.type = type;
        this.id = id;
    }

    public boolean hasId() {
        return this.id != null;
    }

    public String getId() {
        return this.id;
    }

    public JQueryResourceReferenceType getType() {
        return this.type;
    }


    public boolean isOverridable() {
        return getType() == JQueryResourceReferenceType.OVERRIDABLE;
    }

    @Override
    public Time lastModifiedTime() {
        return Time.millis(0L);
    }
}