org.apache.wicket.markup.html.image.Source.java Source code

Introduction

Here is the source code for org.apache.wicket.markup.html.image.Source.java

Source

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */
package org.apache.wicket.markup.html.image;

import org.apache.wicket.markup.ComponentTag;
import org.apache.wicket.model.IModel;
import org.apache.wicket.request.mapper.parameter.PageParameters;
import org.apache.wicket.request.resource.IResource;
import org.apache.wicket.request.resource.ResourceReference;

/**
 * A component which displays localizable image resources within a picture tag.
 *
 * The source tag is the same as the image element, but it is also possible to set the media
 * attribute with setMedia(String media). The second difference is that there is no src attribute,
 * so every ResourceReference and ImageResource is added directly to the srcset attribute.
 *
 * @see org.apache.wicket.markup.html.image.Image
 * @author Tobias Soloschenko
 *
 */
public class Source extends Image {
    private static final long serialVersionUID = 1L;

    private String media = null;

    /**
     * Creates a source for a picture
     * 
     * @param id
     *            the component id
     * @see org.apache.wicket.markup.html.image.Image
     */
    protected Source(final String id) {
        super(id);
    }

    /**
     * Creates a source for a picture
     * 
     * @param id
     *            the component id
     * @param resourceReferences
     *            the resource references applied to the source in the given order
     * @see org.apache.wicket.markup.html.image.Image
     */
    public Source(final String id, final ResourceReference... resourceReferences) {
        super(id, null, resourceReferences);
    }

    /**
     * Creates a source for a picture
     * 
     * @param id
     *            the component id
     * @param resourceParameters
     *            the resource parameters applied to the localized image resource
     * @param resourceReferences
     *            the resource references applied to the source in the given order
     * @see org.apache.wicket.markup.html.image.Image
     */
    public Source(final String id, PageParameters resourceParameters,
            final ResourceReference... resourceReferences) {
        super(id, null, resourceParameters, resourceReferences);
    }

    /**
     * Creates a source for a picture
     * 
     * @param id
     *            the component id
     * @param imageResources
     *            the image resources applied to the source in the given order
     * @see org.apache.wicket.markup.html.image.Image
     */
    public Source(final String id, final IResource... imageResources) {
        super(id, null, imageResources);
    }

    /**
     * Creates a source for a picture
     * 
     * @param id
     *            the component id
     * @param model
     *            the internally used model
     * @see org.apache.wicket.Component#Component(String, IModel)
     */
    public Source(final String id, final IModel<?> model) {
        super(id, model);
    }

    /**
     * Creates a source for a picture
     * 
     * @param id
     *            the component id
     * @param string
     *            the string used as model
     * @see org.apache.wicket.markup.html.image.Image
     */
    public Source(final String id, final String string) {
        super(id, string);
    }

    @Override
    protected void onComponentTag(ComponentTag tag) {
        checkComponentTag(tag, "source");
        super.onComponentTag(tag);
        if (getMedia() != null) {
            tag.put("media", getMedia());
        }
    }

    /**
     * Sets the media attribute information
     *
     * @param media
     *            the media attribute information
     */
    public void setMedia(String media) {
        this.media = media;
    }

    /**
     * Gets the media attribute information
     *
     * @return the media attribute information
     */
    public String getMedia() {
        return media;
    }

    /**
     * Unsupported for source tag
     */
    @Override
    public void setCrossOrigin(Cors crossorigin) {
        throw new UnsupportedOperationException(
                "It is not allowed to set the crossorigin attribute for source tag");
    }

    /**
     * Unsupported for source tag
     */
    @Override
    public final Cors getCrossOrigin() {
        return null;
    }
}