com.sun.webui.jsf.component.Legend 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 com.sun.faces.annotation.Component;
import com.sun.faces.annotation.Property;
import com.sun.webui.jsf.util.ComponentUtilities;
import com.sun.webui.jsf.util.ThemeUtilities;
import com.sun.webui.jsf.theme.ThemeImages;
import com.sun.webui.theme.Theme;
import javax.el.ValueExpression;
import javax.faces.component.NamingContainer;
import javax.faces.component.UIComponent;
import javax.faces.component.UIOutput;
import javax.faces.context.FacesContext;
import javax.faces.convert.Converter;
/**
* The Legend component displays a legend to explain icons used in a page.
*/
@Component(type = "com.sun.webui.jsf.Legend", family = "com.sun.webui.jsf.Legend",
displayName = "Legend", tagName = "legend",
helpKey = "projrave_ui_elements_palette_wdstk-jsf1.2_legend",
propertiesHelpKey = "projrave_ui_elements_palette_wdstk-jsf1.2_propsheets_legend_props")
public class Legend extends UIOutput implements NamingContainer {
/**
* Facet name
*/
public static final String LEGEND_IMAGE_FACET = "legendImage"; //NOI18N
/**
* Default constructor.
*/
public Legend() {
super();
setRendererType("com.sun.webui.jsf.Legend");
}
/**
* Return the family for this component.
*/
@Override
public String getFamily() {
return "com.sun.webui.jsf.Legend";
}
/**
* Return a component that implements a legend image.
* If a facet named legendImage is found
* that component is returned.
* If a facet is not found an Icon
* component instance is returned with the id
* getId() + "_legendImage". The Icon instance
* returned is ThemeImages.LABEL_REQUIRED_ICON.
*
* If a facet is not defined then the returned Icon
* component is created every time this method is called.
*
* @return - legendImage facet or an Icon instance
*/
public UIComponent getLegendImage() {
// First check if an image facet was specified
UIComponent imageFacet = getFacet(LEGEND_IMAGE_FACET);
// If not create one with the default icon.
if (imageFacet != null) {
return imageFacet;
}
Theme theme = ThemeUtilities.getTheme(FacesContext.getCurrentInstance());
Icon icon = ThemeUtilities.getIcon(theme,
ThemeImages.LEGEND_REQUIRED_ICON);
icon.setId(
ComponentUtilities.createPrivateFacetId(this, LEGEND_IMAGE_FACET));
icon.setParent(this);
return icon;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// 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 converter attribute is used to specify a method to translate native
* property values to String and back for this component. The converter
* attribute value must be one of the following:
*
* - A JavaServer Faces EL expression that resolves to a backing bean or
* bean property that implements the
*
javax.faces.converter.Converter interface; or
* - the ID of a registered converter (a String).
*
*/
@Property(name = "converter", isHidden = true, isAttribute = false)
@Override
public Converter getConverter() {
return super.getConverter();
}
// Hide value
@Property(name = "value", isHidden = true, isAttribute = false)
@Override
public Object getValue() {
return super.getValue();
}
/**
* Specifies the position of the legend. Valid values are: "right" (the default) and "left".
*/
@Property(name = "position", displayName = "Legend Position")
private String position = null;
/**
* Specifies the position of the legend. Valid values are: "right" (the default) and "left".
*/
public String getPosition() {
if (this.position != null) {
return this.position;
}
ValueExpression _vb = getValueExpression("position");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Specifies the position of the legend. Valid values are: "right" (the default) and "left".
* @see #getPosition()
*/
public void setPosition(String position) {
this.position = position;
}
/**
* CSS style(s) to be applied to the outermost HTML element when this
* component is rendered.
*/
@Property(name = "style", displayName = "CSS Style(s)")
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)")
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;
}
/**
* The explanatory text that is displayed in the legend. If not specified, the
* required field legend text is displayed.
*/
@Property(name = "text", displayName = "Legend Text")
private String text = null;
/**
* The explanatory text that is displayed in the legend. If not specified, the
* required field legend text is displayed.
*/
public String getText() {
if (this.text != null) {
return this.text;
}
ValueExpression _vb = getValueExpression("text");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* The explanatory text that is displayed in the legend. If not specified, the required field legend text is displayed.
* @see #getText()
*/
public void setText(String text) {
this.text = text;
}
/**
* Use the visible attribute to indicate whether the component should be
* viewable by the user in the rendered HTML page. If set to false, the
* HTML code for the component is present in the page, but the component
* is hidden with style attributes. By default, visible is set to true, so
* HTML for the component HTML is included and visible to the user. If the
* component is not visible, it can still be processed on subsequent form
* submissions because the HTML is present.
*/
@Property(name = "visible", displayName = "Visible")
private boolean visible = false;
private boolean visible_set = false;
/**
* Use the visible attribute to indicate whether the component should be
* viewable by the user in the rendered HTML page. If set to false, the
* HTML code for the component is present in the page, but the component
* is hidden with style attributes. By default, visible is set to true, so
* HTML for the component HTML is included and visible to the user. If the
* component is not visible, it can still be processed on subsequent form
* submissions because the HTML is present.
*/
public boolean isVisible() {
if (this.visible_set) {
return this.visible;
}
ValueExpression _vb = getValueExpression("visible");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return false;
} else {
return ((Boolean) _result).booleanValue();
}
}
return true;
}
/**
* Use the visible attribute to indicate whether the component should be
* viewable by the user in the rendered HTML page. If set to false, the
* HTML code for the component is present in the page, but the component
* is hidden with style attributes. By default, visible is set to true, so
* HTML for the component HTML is included and visible to the user. If the
* component is not visible, it can still be processed on subsequent form
* submissions because the HTML is present.
* @see #isVisible()
*/
public void setVisible(boolean visible) {
this.visible = visible;
this.visible_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.position = (String) _values[1];
this.style = (String) _values[2];
this.styleClass = (String) _values[3];
this.text = (String) _values[4];
this.visible = ((Boolean) _values[5]).booleanValue();
this.visible_set = ((Boolean) _values[6]).booleanValue();
}
/**
* 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.position;
_values[2] = this.style;
_values[3] = this.styleClass;
_values[4] = this.text;
_values[5] = this.visible ? Boolean.TRUE : Boolean.FALSE;
_values[6] = this.visible_set ? Boolean.TRUE : Boolean.FALSE;
return _values;
}
}