jakarta.faces.component.html.HtmlDoctype Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jakarta.faces Show documentation
EE4J Compatible Implementation for Jakarta Faces API
There is a newer version: 4.1.1
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */
package jakarta.faces.component.html;

import java.util.ArrayList;
import java.util.List;

import jakarta.el.ValueExpression;
import jakarta.faces.component.Doctype;
import jakarta.faces.component.UIOutput;

/**
 * NONE
 * 
 * By default, the rendererType property must be set to "jakarta.faces.Doctype". This value
 * can be changed by calling the setRendererType() method.
 * 
 */
public class HtmlDoctype extends UIOutput implements Doctype {

    private static final String OPTIMIZED_PACKAGE = "jakarta.faces.component.";

    public HtmlDoctype() {
        super();
        setRendererType("jakarta.faces.Doctype");
    }

    /**
     * 
     * The standard component type for this component.
     * 
     */
    public static final String COMPONENT_TYPE = "jakarta.faces.OutputDoctype";

    /**
     * The property keys.
     */
    protected enum PropertyKeys {
        publicVal("public"), rootElement, system,;

        String toString;

        PropertyKeys(String toString) {
            this.toString = toString;
        }

        PropertyKeys() {
        }

        @Override
        public String toString() {
            return toString != null ? toString : super.toString();
        }
    }

    /**
     * 
     * Return the value of the public property.
     * 
     *
     * @return the property value
     * 
     * Contents: 
 Will be output as the public part of the DOCTYPE 
     */
    @Override
    public java.lang.String getPublic() {
        return (java.lang.String) getStateHelper().eval(PropertyKeys.publicVal);

    }

    /**
     * 
     * Set the value of the public property.
     * 
     *
     * @param _public the new property value
     */
    public void setPublic(java.lang.String _public) {
        getStateHelper().put(PropertyKeys.publicVal, _public);
        handleAttribute("public", _public);
    }

    /**
     * 
     * Return the value of the rootElement property.
     * 
     *
     * @return the property value
     * 
     * Contents: 
 The root XML element 
     */
    @Override
    public java.lang.String getRootElement() {
        return (java.lang.String) getStateHelper().eval(PropertyKeys.rootElement);

    }

    /**
     * 
     * Set the value of the rootElement property.
     * 
     *
     * @param rootElement the new property value
     */
    public void setRootElement(java.lang.String rootElement) {
        getStateHelper().put(PropertyKeys.rootElement, rootElement);
        handleAttribute("rootElement", rootElement);
    }

    /**
     * 
     * Return the value of the system property.
     * 
     *
     * @return the property value
     * 
     * Contents: 
 Will be output as the system part of the DOCTYPE 
     */
    @Override
    public java.lang.String getSystem() {
        return (java.lang.String) getStateHelper().eval(PropertyKeys.system);

    }

    /**
     * 
     * Set the value of the system property.
     * 
     *
     * @param system the new property value
     */
    public void setSystem(java.lang.String system) {
        getStateHelper().put(PropertyKeys.system, system);
        handleAttribute("system", system);
    }

    private void handleAttribute(String name, Object value) {
        List setAttributes = (List) getAttributes().get("jakarta.faces.component.UIComponentBase.attributesThatAreSet");
        if (setAttributes == null) {
            String cname = this.getClass().getName();
            if (cname != null && cname.startsWith(OPTIMIZED_PACKAGE)) {
                setAttributes = new ArrayList<>(6);
                getAttributes().put("jakarta.faces.component.UIComponentBase.attributesThatAreSet", setAttributes);
            }
        }
        if (setAttributes != null) {
            if (value == null) {
                ValueExpression ve = getValueExpression(name);
                if (ve == null) {
                    setAttributes.remove(name);
                }
            } else if (!setAttributes.contains(name)) {
                setAttributes.add(name);
            }
        }
    }

}