com.sun.webui.jsf.component.Page Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the license at
* https://woodstock.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at https://woodstock.dev.java.net/public/CDDLv1.0.html.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* you own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Copyright 2007 Sun Microsystems, Inc. All rights reserved.
*/
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 Page component is used to indicate the beginning of the part of the JSP
* page that is used by the Sun Java Web UI Components.
*/
@Component(type = "com.sun.webui.jsf.Page", family = "com.sun.webui.jsf.Page",
displayName = "Page", tagName = "page",
helpKey = "projrave_ui_elements_palette_wdstk-jsf1.2_page",
propertiesHelpKey = "projrave_ui_elements_palette_wdstk-jsf1.2_propsheets_page_props")
public class Page extends UIComponentBase {
/**
* Construct a new Page.
*/
public Page() {
super();
setRendererType("com.sun.webui.jsf.Page");
}
/**
* Return the family for this component.
*/
public String getFamily() {
return "com.sun.webui.jsf.Page";
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// 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);
}
/**
* Use the frame attribute to
* indicate whether the page should render frames. If this attribute is
* true, the rendered HTML page includes a <frameset> element. If false, the rendered page
* uses a <body> tag. This attribute also
* influences the rendering of the <!DOCTYPE>
* attribute. If frameset is true, the <!DOCTYPE> will
* be one of the following,
* depending on the setting of xhtml attribute.
* <!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
<!DOCTYPE html
PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN"
"http://www.w3.org/TR/html4/DTD/frameset.dtd">
*/
@Property(name = "frame", displayName = "Needs Frame", category = "Appearance")
private boolean frame = false;
private boolean frame_set = false;
/**
* Use the frame attribute to
* indicate whether the page should render frames. If this attribute is
* true, the rendered HTML page includes a <frameset> element. If false, the rendered page
* uses a <body> tag. This attribute also
* influences the rendering of the <!DOCTYPE>
* attribute. If frameset is true, the <!DOCTYPE> will
* be one of the following,
* depending on the setting of xhtml attribute.
* <!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
<!DOCTYPE html
PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN"
"http://www.w3.org/TR/html4/DTD/frameset.dtd">
*/
public boolean isFrame() {
if (this.frame_set) {
return this.frame;
}
ValueExpression _vb = getValueExpression("frame");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return false;
} else {
return ((Boolean) _result).booleanValue();
}
}
return false;
}
/**
* Use the frame attribute to
* indicate whether the page should render frames. If this attribute is
* true, the rendered HTML page includes a <frameset> element. If false, the rendered page
* uses a <body> tag. This attribute also
* influences the rendering of the <!DOCTYPE>
* attribute. If frameset is true, the <!DOCTYPE> will
* be one of the following,
* depending on the setting of xhtml attribute.
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
<!DOCTYPE html
PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN"
"http://www.w3.org/TR/html4/DTD/frameset.dtd">
* @see #isFrame()
*/
public void setFrame(boolean frame) {
this.frame = frame;
this.frame_set = true;
}
/**
* XHTML transitional page or HTML
* transitional page. This attribute influences
* the rendering of the <!DOCTYPE> attribute. If xhtml
* is true, the <!DOCTYPE> will be one of the
* following,
* depending on the setting of frameset attribute.
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd"
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
*/
@Property(name = "xhtml", displayName = "XHTML Transitional", category = "Appearance")
private boolean xhtml = false;
private boolean xhtml_set = false;
/**
* XHTML transitional page or HTML
* transitional page. This attribute influences
* the rendering of the <!DOCTYPE> attribute. If xhtml
* is true, the <!DOCTYPE> will be one of the
* following,
* depending on the setting of frameset attribute.
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd"
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
*/
public boolean isXhtml() {
if (this.xhtml_set) {
return this.xhtml;
}
ValueExpression _vb = getValueExpression("xhtml");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return false;
} else {
return ((Boolean) _result).booleanValue();
}
}
return true;
}
/**
* XHTML transitional page or HTML
* transitional page. This attribute influences
* the rendering of the <!DOCTYPE> attribute. If xhtml
* is true, the <!DOCTYPE> will be one of the
* following,
* depending on the setting of frameset attribute.
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd"
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
* @see #isXhtml()
*/
public void setXhtml(boolean xhtml) {
this.xhtml = xhtml;
this.xhtml_set = true;
}
/**
* Restore the state of this component.
*/
@Override
public void restoreState(FacesContext _context, Object _state) {
Object _values[] = (Object[]) _state;
super.restoreState(_context, _values[0]);
this.frame = ((Boolean) _values[1]).booleanValue();
this.frame_set = ((Boolean) _values[2]).booleanValue();
this.xhtml = ((Boolean) _values[3]).booleanValue();
this.xhtml_set = ((Boolean) _values[4]).booleanValue();
}
/**
* Save the state of this component.
*/
@Override
public Object saveState(FacesContext _context) {
Object _values[] = new Object[5];
_values[0] = super.saveState(_context);
_values[1] = this.frame ? Boolean.TRUE : Boolean.FALSE;
_values[2] = this.frame_set ? Boolean.TRUE : Boolean.FALSE;
_values[3] = this.xhtml ? Boolean.TRUE : Boolean.FALSE;
_values[4] = this.xhtml_set ? Boolean.TRUE : Boolean.FALSE;
return _values;
}
}