org.icefaces.ace.component.dynamicresource.DynamicResourceMeta Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of icefaces-ace Show documentation
${icefaces.product.name} ACE Component Library
There is a newer version: 4.3.0
/*
 * Copyright 2004-2014 ICEsoft Technologies Canada Corp.
 *
 * Licensed 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.icefaces.ace.component.dynamicresource;

import org.icefaces.ace.meta.annotation.Component;
import org.icefaces.ace.meta.annotation.Property;

import javax.faces.application.Resource;
import java.util.Date;

@Component(
        tagName         = "dynamicResource",
        componentClass  = "org.icefaces.ace.component.dynamicresource.DynamicResource",
        generatedClass  = "org.icefaces.ace.component.dynamicresource.DynamicResourceBase",
        rendererClass   = "org.icefaces.ace.component.dynamicresource.DynamicResourceRenderer",
        extendsClass    = "javax.faces.component.UIComponentBase",
        componentType   = "org.icefaces.ace.component.DynamicResource",
        rendererType    = "org.icefaces.ace.component.DynamicResourceRenderer",
        componentFamily = "org.icefaces.ace.component",
        tlddoc = "")
public class DynamicResourceMeta {
    @Property(tlddoc = "Custom inline CSS styles to use for this component. These styles are generally applied to the root DOM element of the component. This is intended for per-component basic style customizations. Note that due to browser CSS precedence rules, CSS rendered on a DOM element will take precedence over the external stylesheets used to provide the ThemeRoller theme on this component. If the CSS properties applied with this attribute do not affect the DOM element you want to style, you may need to create a custom theme styleClass for the theme CSS class that targets the particular DOM elements you wish to customize.")
    private String style;

    @Property(tlddoc = "Custom CSS style class(es) to use for this component. These style classes can be defined in your page or in a theme CSS file.")
    private String styleClass;

    @Property(tlddoc="The file name to be used for the attachment header. If the label is not specified the file name will be used. See also the resource attribute. Note: a specific file name only works if the file is downloaded as an attachment. Setting this attribute to anything but null will cause the file to be downloaded as an attachment, instead of being loaded right in the browser.")
    private String fileName;

    @Property(tlddoc="The image path that will be used to display an image for link instead of text.")
    private String image;

    @Property(tlddoc="The type of link to render: link (default) image: renders a link with an image (must be used with the image attribute) button: renders a button with the text from value")
    private String type;

    @Property(tlddoc="The label to be displayed for the resource. The label will be used for the text of the link or button. If an image is used, the label will be used as the alt attribute value of the image element.")
    private String label;

    @Property(tlddoc="(Deprecated) Setting the fileName attribute will cause the file to be downloaded as an attachment, instead of loading it right in the browser.")
    private boolean attachment;

    @Property(tlddoc="Value of the target attribute when resource is rendered as a link and image.", defaultValue="_blank")
    private String target;

    @Property(tlddoc="The mime-type for the resource. If not specified, and available from the backing Resource, the Resource's mime-type will be used. See also the resource attribute.")
    private String mimeType;

    @Property(tlddoc="The java.util.Data object specifying the last modified header that will be sent to the browser for this resource. See also the resource attribute.")
    private Date lastModified;

    @Property(tlddoc="Flag indicating that this element must never receive focus or be included in a subsequent submit.")
    private boolean disabled;

    @Property(tlddoc="The object of type com.icesoft.faces.context.Resource that will be used. It can be use to override the fileName, lastModified and mimeType attributes via the withOptions() method.")
    private Resource resource;

    @Property(tlddoc="The scope in which the resource will be stored. The values can be 'flash', 'view', window', 'session', and 'application'. When not specified the 'session' scope is used.")
    private String scope;

	@Property(tlddoc = "Access key that, when pressed, transfers focus to this component.")
	String accesskey;
}