com.icesoft.faces.component.style.OutputStyle Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of icefaces-compat Show documentation
${icefaces.product.name} Compat Component Library
There is a newer version: 3.3.0
/*
 * Copyright 2004-2012 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 com.icesoft.faces.component.style;

import javax.faces.component.UIComponentBase;
import javax.faces.el.ValueBinding;
import javax.faces.context.FacesContext;

/**
 * The OutputStyle component will include an additional style sheet for Internet
 * Explorer and Safari browsers. An additional style sheet will also be included
 * when rendered in Sun Studio Creator design time. This allows style classes to
 * be overridden for specific browsers.
 */
public class OutputStyle extends UIComponentBase {

    public static final String COMPONENT_TYPE =
            "com.icesoft.faces.OutputStyleComp";
    public static final String COMPONENT_FAMILY =
            "com.icesoft.faces.OutputStyle";
    public static final String DEFAULT_RENDERER_TYPE =
            "com.icesoft.faces.style.OutputStyleRenderer";

    /**
     * The href value of the link element that is rendered. An additional link
     * ellement is rendered for internet explorer and Safari browsers. An
     * additional style sheet is specifed when in design time in Studio Creator.
     * The IE style sheet must end with '_ie.css', and the Safari style sheet
     * must end with '_safari.css'. Design Time is '_dt.css' For example if the
     * href value is 'style.css' then the IE style sheet needs to be named
     * 'style_ie.css'
     */
    private String href;
    private String userAgent;

    public OutputStyle() {
        super();
    }

    public String getFamily() {
        return COMPONENT_FAMILY;
    }

    public String getRendererType() {
        return DEFAULT_RENDERER_TYPE;
    }

    /**
     * Returns the href value of the link element that is rendered.
     */
    public String getHref() {
        if (href != null) {
            return href;
        }
        ValueBinding vb = getValueBinding("href");
        if (vb != null) {
            return (String) vb.getValue(getFacesContext());
        }
        return null;
    }

    public String getUserAgent() {
        return userAgent;
    }

    public void setUserAgent(String userAgent) {
        this.userAgent = userAgent;
    }

    /**
     * Sets the href value of the link element that is rendered.
     * 
     * The href value of the link element that is rendered. An additional link
     * element is rendered for internet explorer and Safari browsers. An
     * additional style sheet is specifed when in design time in Studio Creator.
     * The IE style sheet must end with '_ie.css', and the Safari style sheet
     * must end with '_safari.css'. Design Time is '_dt.css' For example if the
     * href value is 'style.css' then the IE style sheet needs to be named
     * 'style_ie.css' 
     */
    public void setHref(String href) {
        this.href = href;
    }

    /**
     * Gets the state of the instance as a Serializable
     * Object.
     */
    public Object saveState(FacesContext context) {
        Object values[] = new Object[3];
        values[0] = super.saveState(context);
        values[1] = href;
        values[2] = userAgent;
        return ((Object) (values));
    }

    /**
     * Perform any processing required to restore the state from the entries
     * in the state Object.
     */
    public void restoreState(FacesContext context, Object state) {
        Object values[] = (Object[]) state;
        super.restoreState(context, values[0]);
        href = (String) values[1];
        userAgent = (String) values[2];
    }
}