com.sun.webui.jsf.component.FrameSet 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 FrameSet component defines a set of frames.
*/
@Component(type = "com.sun.webui.jsf.FrameSet", family = "com.sun.webui.jsf.FrameSet",
displayName = "Frame Set", tagName = "frameSet",
helpKey = "projrave_ui_elements_palette_wdstk-jsf1.2_frame_set",
propertiesHelpKey = "projrave_ui_elements_palette_wdstk-jsf1.2_propsheets_frame_set_props")
public class FrameSet extends UIComponentBase {
/**
* Construct a new FrameSet.
*/
public FrameSet() {
super();
setRendererType("com.sun.webui.jsf.FrameSet");
}
/**
* Return the family for this component.
*/
public String getFamily() {
return "com.sun.webui.jsf.FrameSet";
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// 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);
}
/**
* The width, in pixels, of the space around frames. The frameSpacing
* attribute and the border attribute set the same property in different
* browsers. Set frameSpacing and border to the same value.
*/
@Property(name = "border", displayName = "border", category = "Appearance",
editorClassName = "com.sun.rave.propertyeditors.IntegerPropertyEditor")
private int border = Integer.MIN_VALUE;
private boolean border_set = false;
/**
* The width, in pixels, of the space around frames. The frameSpacing
* attribute and the border attribute set the same property in different
* browsers. Set frameSpacing and border to the same value.
*/
public int getBorder() {
if (this.border_set) {
return this.border;
}
ValueExpression _vb = getValueExpression("border");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return Integer.MIN_VALUE;
} else {
return ((Integer) _result).intValue();
}
}
return Integer.MIN_VALUE;
}
/**
* The width, in pixels, of the space around frames. The frameSpacing
* attribute and the border attribute set the same property in different
* browsers. Set frameSpacing and border to the same value.
* @see #getBorder()
*/
public void setBorder(int border) {
this.border = border;
this.border_set = true;
}
/**
* The bordercolor attribute allows you to set the color of the frame
* borders using a hex value or a color name.
*/
@Property(name = "borderColor", displayName = "Border Color", category = "Appearance")
private String borderColor = null;
/**
* The bordercolor attribute allows you to set the color of the frame
* borders using a hex value or a color name.
*/
public String getBorderColor() {
if (this.borderColor != null) {
return this.borderColor;
}
ValueExpression _vb = getValueExpression("borderColor");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* The bordercolor attribute allows you to set the color of the frame
* borders using a hex value or a color name.
* @see #getBorderColor()
*/
public void setBorderColor(String borderColor) {
this.borderColor = borderColor;
}
/**
* Defines the number and size of columns in a frameset. The size can be
* specified in pixels, percentage of the page width, or with an
* asterisk (*). Specifying * causes the columns to use available space.
* See the HTML specification for the frameset element for more details.
*/
@Property(name = "cols", displayName = "Number of Columns", category = "Appearance", isDefault = true)
private String cols = null;
/**
* Defines the number and size of columns in a frameset. The size can be
* specified in pixels, percentage of the page width, or with an
* asterisk (*). Specifying * causes the columns to use available space.
* See the HTML specification for the frameset element for more details.
*/
public String getCols() {
if (this.cols != null) {
return this.cols;
}
ValueExpression _vb = getValueExpression("cols");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Defines the number and size of columns in a frameset. The size can be
* specified in pixels, percentage of the page width, or with an
* asterisk (*). Specifying * causes the columns to use available space.
* See the HTML specification for the frameset element for more details.
* @see #getCols()
*/
public void setCols(String cols) {
this.cols = cols;
}
/**
* Flag indicating whether frames should have borders or not. If
* frameBorder is true, decorative borders are drawn. If frameBorder is
* false, a space between frames shows up as the background color of the
* page. To show no border or space between frames, you should set
* frameBorder to false, and set frameSpacing and border to 0.
*/
@Property(name = "frameBorder", displayName = "Frame Border", category = "Appearance")
private boolean frameBorder = false;
private boolean frameBorder_set = false;
/**
* Flag indicating whether frames should have borders or not. If
* frameBorder is true, decorative borders are drawn. If frameBorder is
* false, a space between frames shows up as the background color of the
* page. To show no border or space between frames, you should set
* frameBorder to false, and set frameSpacing and border to 0.
*/
public boolean isFrameBorder() {
if (this.frameBorder_set) {
return this.frameBorder;
}
ValueExpression _vb = getValueExpression("frameBorder");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return false;
} else {
return ((Boolean) _result).booleanValue();
}
}
return false;
}
/**
* Flag indicating whether frames should have borders or not. If
* frameBorder is true, decorative borders are drawn. If frameBorder is
* false, a space between frames shows up as the background color of the
* page. To show no border or space between frames, you should set
* frameBorder to false, and set frameSpacing and border to 0.
* @see #isFrameBorder()
*/
public void setFrameBorder(boolean frameBorder) {
this.frameBorder = frameBorder;
this.frameBorder_set = true;
}
/**
* The width, in pixels, of the space around frames. The frameSpacing attribute
* and the border attribute set the same property in different browsers.
* Set frameSpacing and border to the same value.
*/
@Property(name = "frameSpacing", displayName = "Frame Spacing", category = "Appearance",
editorClassName = "com.sun.rave.propertyeditors.IntegerPropertyEditor")
private int frameSpacing = Integer.MIN_VALUE;
private boolean frameSpacing_set = false;
/**
* The width, in pixels, of the space around frames. The frameSpacing attribute
* and the border attribute set the same property in different browsers.
* Set frameSpacing and border to the same value.
*/
public int getFrameSpacing() {
if (this.frameSpacing_set) {
return this.frameSpacing;
}
ValueExpression _vb = getValueExpression("frameSpacing");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return Integer.MIN_VALUE;
} else {
return ((Integer) _result).intValue();
}
}
return Integer.MIN_VALUE;
}
/**
* The width, in pixels, of the space around frames. The frameSpacing attribute
* and the border attribute set the same property in different browsers.
* Set frameSpacing and border to the same value.
* @see #getFrameSpacing()
*/
public void setFrameSpacing(int frameSpacing) {
this.frameSpacing = frameSpacing;
this.frameSpacing_set = true;
}
/**
* Defines the number and size of rows in a frameset. The size can be
* specified in pixels, percentage of the page length, or with an
* asterisk (*). Specifying * causes the rows to use available space.
* See the HTML specification for the frameset element for more details.
*/
@Property(name = "rows", displayName = "Number of Rows", category = "Appearance")
private String rows = null;
/**
* Defines the number and size of rows in a frameset. The size can be
* specified in pixels, percentage of the page length, or with an
* asterisk (*). Specifying * causes the rows to use available space.
* See the HTML specification for the frameset element for more details.
*/
public String getRows() {
if (this.rows != null) {
return this.rows;
}
ValueExpression _vb = getValueExpression("rows");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Defines the number and size of rows in a frameset. The size can be
* specified in pixels, percentage of the page length, or with an
* asterisk (*). Specifying * causes the rows to use available space.
* See the HTML specification for the frameset element for more details.
* @see #getRows()
*/
public void setRows(String rows) {
this.rows = rows;
}
/**
* 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;
}
/**
* Sets the value of the title attribute for the HTML element.
* The specified text will display as a tooltip if the mouse cursor hovers
* over the HTML element.
*/
@Property(name = "toolTip", displayName = "Tool Tip", category = "Behavior",
editorClassName = "com.sun.rave.propertyeditors.StringPropertyEditor")
private String toolTip = null;
/**
* Sets the value of the title attribute for the HTML element.
* The specified text will display as a tooltip if the mouse cursor hovers
* over the HTML element.
*/
public String getToolTip() {
if (this.toolTip != null) {
return this.toolTip;
}
ValueExpression _vb = getValueExpression("toolTip");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Sets the value of the title attribute for the HTML element.
* The specified text will display as a tooltip if the mouse cursor hovers
* over the HTML element.
* @see #getToolTip()
*/
public void setToolTip(String toolTip) {
this.toolTip = toolTip;
}
/**
* Restore the state of this component.
*/
@Override
public void restoreState(FacesContext _context, Object _state) {
Object _values[] = (Object[]) _state;
super.restoreState(_context, _values[0]);
this.border = ((Integer) _values[1]).intValue();
this.border_set = ((Boolean) _values[2]).booleanValue();
this.borderColor = (String) _values[3];
this.cols = (String) _values[4];
this.frameBorder = ((Boolean) _values[5]).booleanValue();
this.frameBorder_set = ((Boolean) _values[6]).booleanValue();
this.frameSpacing = ((Integer) _values[7]).intValue();
this.frameSpacing_set = ((Boolean) _values[8]).booleanValue();
this.rows = (String) _values[9];
this.style = (String) _values[10];
this.styleClass = (String) _values[11];
this.toolTip = (String) _values[12];
}
/**
* Save the state of this component.
*/
@Override
public Object saveState(FacesContext _context) {
Object _values[] = new Object[13];
_values[0] = super.saveState(_context);
_values[1] = new Integer(this.border);
_values[2] = this.border_set ? Boolean.TRUE : Boolean.FALSE;
_values[3] = this.borderColor;
_values[4] = this.cols;
_values[5] = this.frameBorder ? Boolean.TRUE : Boolean.FALSE;
_values[6] = this.frameBorder_set ? Boolean.TRUE : Boolean.FALSE;
_values[7] = new Integer(this.frameSpacing);
_values[8] = this.frameSpacing_set ? Boolean.TRUE : Boolean.FALSE;
_values[9] = this.rows;
_values[10] = this.style;
_values[11] = this.styleClass;
_values[12] = this.toolTip;
return _values;
}
}