com.sun.webui.jsf.component.Markup Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2007-2018 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.webui.jsf.component;
import javax.el.ValueExpression;
import javax.faces.component.UIComponentBase;
import javax.faces.context.FacesContext;
import com.sun.faces.annotation.Component;
import com.sun.faces.annotation.Property;
/**
* The Markup component allows HTML elements to be inserted into the JSP page
* where HTML is not permitted inside a JSF tag.
*/
@Component(type = "com.sun.webui.jsf.Markup", family = "com.sun.webui.jsf.Markup",
displayName = "Markup", tagName = "markup",
helpKey = "projrave_ui_elements_palette_wdstk-jsf1.2_markup",
propertiesHelpKey = "projrave_ui_elements_palette_wdstk-jsf1.2_propsheets_markup_props")
public class Markup extends UIComponentBase {
/**
* Construct a new Markup.
*/
public Markup() {
super();
setRendererType("com.sun.webui.jsf.Markup");
}
/**
* Return the family for this component.
*/
public String getFamily() {
return "com.sun.webui.jsf.Markup";
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Tag attribute methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* The component identifier for this component. This value must be unique
* within the closest parent component that is a naming container.
*/
@Property(name = "id")
@Override
public void setId(String id) {
super.setId(id);
}
/**
* Use the rendered attribute to indicate whether the HTML code for the
* component should be included in the rendered HTML page. If set to false,
* the rendered HTML page does not include the HTML for the component. If
* the component is not rendered, it is also not processed on any subsequent
* form submission.
*/
@Property(name = "rendered")
@Override
public void setRendered(boolean rendered) {
super.setRendered(rendered);
}
/**
* Add the rest of the attribute name="value" type pairs inside this
* attribute. The inserted attributes will need to be escaped.
*/
@Property(name = "extraAttributes", displayName = "Extra Attributes", category = "Advanced",
editorClassName = "com.sun.rave.propertyeditors.StringPropertyEditor")
private String extraAttributes = null;
/**
* Add the rest of the attribute name="value" type pairs inside this
* attribute. The inserted attributes will need to be escaped.
*/
public String getExtraAttributes() {
if (this.extraAttributes != null) {
return this.extraAttributes;
}
ValueExpression _vb = getValueExpression("extraAttributes");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Add the rest of the attribute name="value" type pairs inside this
* attribute. The inserted attributes will need to be escaped.
* @see #getExtraAttributes()
*/
public void setExtraAttributes(String extraAttributes) {
this.extraAttributes = extraAttributes;
}
/**
* Flag indicating that tag is a singleton tag and that it should end with
* a trailing /
*/
@Property(name = "singleton", displayName = "Single Tag", category = "Advanced")
private boolean singleton = false;
private boolean singleton_set = false;
/**
* Flag indicating that tag is a singleton tag and that it should end with
* a trailing /
*/
public boolean isSingleton() {
if (this.singleton_set) {
return this.singleton;
}
ValueExpression _vb = getValueExpression("singleton");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return false;
} else {
return ((Boolean) _result).booleanValue();
}
}
return false;
}
/**
* Flag indicating that tag is a singleton tag and that it should end with
* a trailing /
* @see #isSingleton()
*/
public void setSingleton(boolean singleton) {
this.singleton = singleton;
this.singleton_set = true;
}
/**
* CSS style(s) to be applied to the outermost HTML element when this
* component is rendered.
*/
@Property(name = "style", displayName = "CSS Style(s)", category = "Appearance",
editorClassName = "com.sun.jsfcl.std.css.CssStylePropertyEditor")
private String style = null;
/**
* CSS style(s) to be applied to the outermost HTML element when this
* component is rendered.
*/
public String getStyle() {
if (this.style != null) {
return this.style;
}
ValueExpression _vb = getValueExpression("style");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* CSS style(s) to be applied to the outermost HTML element when this
* component is rendered.
* @see #getStyle()
*/
public void setStyle(String style) {
this.style = style;
}
/**
* CSS style class(es) to be applied to the outermost HTML element when this
* component is rendered.
*/
@Property(name = "styleClass", displayName = "CSS Style Class(es)", category = "Appearance",
editorClassName = "com.sun.rave.propertyeditors.StyleClassPropertyEditor")
private String styleClass = null;
/**
* CSS style class(es) to be applied to the outermost HTML element when this
* component is rendered.
*/
public String getStyleClass() {
if (this.styleClass != null) {
return this.styleClass;
}
ValueExpression _vb = getValueExpression("styleClass");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* CSS style class(es) to be applied to the outermost HTML element when this
* component is rendered.
* @see #getStyleClass()
*/
public void setStyleClass(String styleClass) {
this.styleClass = styleClass;
}
/**
* Name of the HTML element to render.
*/
@Property(name = "tag", displayName = "Tag Name", category = "Advanced", isDefault = true,
editorClassName = "com.sun.rave.propertyeditors.StringPropertyEditor")
private String tag = null;
/**
* Name of the HTML element to render.
*/
public String getTag() {
if (this.tag != null) {
return this.tag;
}
ValueExpression _vb = getValueExpression("tag");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Name of the HTML element to render.
* @see #getTag()
*/
public void setTag(String tag) {
this.tag = tag;
}
/**
* Restore the state of this component.
*/
@Override
public void restoreState(FacesContext _context, Object _state) {
Object _values[] = (Object[]) _state;
super.restoreState(_context, _values[0]);
this.extraAttributes = (String) _values[1];
this.singleton = ((Boolean) _values[2]).booleanValue();
this.singleton_set = ((Boolean) _values[3]).booleanValue();
this.style = (String) _values[4];
this.styleClass = (String) _values[5];
this.tag = (String) _values[6];
}
/**
* Save the state of this component.
*/
@Override
public Object saveState(FacesContext _context) {
Object _values[] = new Object[7];
_values[0] = super.saveState(_context);
_values[1] = this.extraAttributes;
_values[2] = this.singleton ? Boolean.TRUE : Boolean.FALSE;
_values[3] = this.singleton_set ? Boolean.TRUE : Boolean.FALSE;
_values[4] = this.style;
_values[5] = this.styleClass;
_values[6] = this.tag;
return _values;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy