com.sun.webui.jsf.component.ListSelector 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.Property;
import com.sun.webui.jsf.model.Option;
import com.sun.webui.jsf.model.OptionGroup;
import com.sun.webui.jsf.model.OptionTitle;
import com.sun.webui.jsf.model.Separator;
import com.sun.webui.jsf.model.list.EndGroup;
import com.sun.webui.jsf.model.list.ListItem;
import com.sun.webui.jsf.model.list.StartGroup;
import com.sun.webui.jsf.util.ComponentUtilities;
import com.sun.webui.jsf.util.ConversionUtilities;
import com.sun.webui.jsf.util.MessageUtil;
import com.sun.webui.jsf.util.ValueType;
import java.beans.Beans;
import java.lang.reflect.Array;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.Map;
import javax.el.ValueExpression;
import javax.faces.FacesException;
import javax.faces.component.NamingContainer;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
/**
* Base component for UI components that allow the user to make a
* selection from a list of options using an HTML select element.
*/
public class ListSelector extends Selector implements ListManager,
NamingContainer {
// If true, debugging statements are printed to stdout
private static final boolean DEBUG = false;
// Holds the options for this component
protected ArrayList listItems = null;
private int separatorLength = 0;
private static final String READONLY_ID = "_readOnly"; //NOI18N
private static final String LABEL_ID = "_label"; //NOI18N
private static final String READONLY_FACET = "readOnly"; //NOI18N
private static final String LABEL_FACET = "label"; //NOI18N
public static final String VALUE_ID = "_list_value"; //NOI18N
public static final String VALUE_LABEL_ID = "_hiddenlabel"; //NOI18N
public static final String LIST_ID = "_list"; //NOI18N
/** Creates a new instance of ListSelector */
public ListSelector() {
setRendererType("com.sun.webui.jsf.ListSelectorRenderer");
}
/**
* Return the family for this component.
*/
@Override
public String getFamily() {
return "com.sun.webui.jsf.ListSelector";
}
/**
* Check that this component has a valuebinding that matches the
* value of the "multiple" attribute.
* @param context The FacesContext of the request
*/
public void checkSelectionModel(FacesContext context) {
if (DEBUG) {
log("checkSelectionModel()"); //NOI18N
log("\tComponent multiple = " + String.valueOf(isMultiple())); //NOI18N
log("\tValueType " + valueTypeEvaluator.getValueType().toString()); //NOI18N
}
if (isMultiple() &&
valueTypeEvaluator.getValueType() != ValueType.ARRAY) {
if (DEBUG) {
log("\tMultiple selection enabled for non-array value");//NOI18N
}
Object[] params = {toString()};
String msg = MessageUtil.getMessage("com.sun.webui.jsf.resources.LogMessages", //NOI18N
"Selector.multipleError", //NOI18N
params);
throw new RuntimeException(msg);
}
return;
}
/**
* Retrieve an Iterator of ListSelector.ListItem, to be used by the
* renderer.
* @return an Iterator over {@link ListItem}.
*/
public Iterator getListItems(FacesContext context, boolean rulerAtEnd)
throws FacesException {
if (DEBUG) {
log("getListItems()"); //NOI18N
}
listItems = new ArrayList();
separatorLength = 0;
// Retrieve the current selections. If there are selected
// objects, mark the corresponding items as selected.
processOptions(getOptions());
processSelections();
return listItems.iterator();
}
/**
* Retrieve an Iterator of ListSelector.ListItem, to be used when
* evaluting the list items. If the list items are needed by the
* renderer, use getListItems(context, rulerAtEnd) instead.
* @return an Iterator over {@link ListItem}.
*/
public Iterator getListItems() throws FacesException {
if (DEBUG) {
log("getListItems()"); //NOI18N
}
if (listItems != null) {
return listItems.iterator();
}
listItems = new ArrayList();
processOptions(getOptions());
return listItems.iterator();
}
/**
* This method resets the options. Use this only if you need to
* add or remove options after the component has been rendered once.
public void resetOptions() {
listItems = null;
}
*/
public int getSeparatorLength() {
return separatorLength;
}
/**
* Processes the component's SelectItems. Constructs an ArrayList
* of Selector.Options.
*
*
* - General algorithm copied from the RI, except that I modified
* the class casts for readability. I don't think the algorithm is
* correct though, need to verify.
* - The list of allowed data types must match the spec.
* - This code will have to be replaced when switching
* to Selection.
*
*/
protected Option[] getOptions() {
Option[] options = null;
Object optionsObject = getItems();
// TODO - add some error reporting...
if (optionsObject instanceof Option[]) {
options = (Option[]) optionsObject;
} else if (optionsObject instanceof Collection) {
Object[] objects = ((Collection) optionsObject).toArray();
if (objects == null || objects.length == 0) {
options = new Option[0];
}
int numObjects = objects.length;
options = new Option[numObjects];
for (int counter = 0; counter < numObjects; ++counter) {
options[counter] = (Option) objects[counter];
}
} else if (optionsObject instanceof Map) {
Collection itemsCollection = ((Map) optionsObject).values();
options = (Option[]) (itemsCollection.toArray());
} // The items attribute has not been specified
else {
// do nothing
options = new Option[0];
}
return options;
}
protected void processOptions(Option[] options) {
if (DEBUG) {
log("processOptions()"); //NOI18N
}
int length = options.length;
for (int counter = 0; counter < length; ++counter) {
if (options[counter] instanceof OptionGroup) {
OptionGroup selectionGroup =
(OptionGroup) options[counter];
String groupLabel = selectionGroup.getLabel();
if (DEBUG) {
log("\tFound SelectionGroup"); //NOI18N
log("\tLabel is " + groupLabel); //NOI18N
}
if ((groupLabel.length() * 1.5) > separatorLength) {
// FIXME - needs to be dependent on the
// browser if not the OS... ARRGGH.
separatorLength = (int) (groupLabel.length() * 1.5);
}
listItems.add(new StartGroup(groupLabel));
processOptions(selectionGroup.getOptions());
listItems.add(new EndGroup());
} else if (options[counter] instanceof Separator) {
listItems.add(options[counter]);
} else {
listItems.add(createListItem(options[counter]));
}
}
}
/**
* Retrieve the current selections and compare them with the list
* items.
*/
protected void processSelections() {
if (DEBUG) {
log("processSelections()"); //NOI18N
}
// For the "immediate" case:
Object value = getSubmittedValue();
if (value != null) {
if (DEBUG) {
log("Found submitted value"); //NOI18N
}
if (value instanceof String[]) {
if (DEBUG) {
log("found submitted value (string array)"); //NOI18N
}
String[] obj = (String[]) value;
ArrayList list = new ArrayList(obj.length);
for (int counter = 0; counter < obj.length; ++counter) {
list.add(obj[counter]);
if (DEBUG) {
log("\tAdded " + obj[counter]); //NOI18N
}
}
markSelectedListItems(list, false);
return;
}
throw new IllegalArgumentException("Illegal submitted value"); //NOI18N
}
// For the first time and "non-immediate" case:
if (DEBUG) {
log("No submitted values, use actual value");//NOI18N
}
// Covers List cases
if (valueTypeEvaluator.getValueType() == ValueType.NONE ||
valueTypeEvaluator.getValueType() == ValueType.INVALID) {
if (DEBUG) {
log("\tNo value");
}
markSelectedListItems(new ArrayList(), true);
return;
}
value = getValue();
if (DEBUG) {
if (value == null) {
log("\t actual value is null"); //NOI18N
} else {
log("\t actual value is of type " + //NOI18N
value.getClass().getName());
}
}
if (value == null) {
if (DEBUG) {
log("\tNo value");//NOI18N
}
markSelectedListItems(new ArrayList(), true);
return;
}
// Covers List cases
/*
if(valueTypeEvaluator.getValueType() == ValueType.LIST) {
if(DEBUG) log("found actual value (list)");
Object[] params = { toString() };
String msg =
ThemeUtilities.getTheme(FacesContext.getCurrentInstance()).
getMessage("ListSelector.multipleError", params); //NOI18N
throw new IllegalArgumentException(msg);
//markSelectedOptions((java.util.List)value, true);
//return;
}
*/
ArrayList list = new ArrayList();
// Covers Object array
if (valueTypeEvaluator.getValueType() == ValueType.ARRAY) {
int length = Array.getLength(value);
for (int counter = 0; counter < length; ++counter) {
list.add(Array.get(value, counter));
if (DEBUG) {
log(String.valueOf(Array.get(value, counter)));
}
}
markSelectedListItems(list, true);
return;
}
// Covers Object array
list.add(value);
if (DEBUG) {
log("\tAdded object " + String.valueOf(value)); //NOI18N
}
markSelectedListItems(list, true);
return;
}
/**
* Marks options corresponding to objects listed as values of this
* components as selected.
* @param list A list representation of the selected values
* @param processed If true, compare the values object by
* object (this is done if we compare the value of the object with
* with the list items). If false, perform a string comparison of
* the string representation of the submitted value of the
* component with the string representation of the value from the
* list items (this is done if we compare the submitted values
* with the list items). */
protected void markSelectedListItems(java.util.List list,
boolean processed) {
if (DEBUG) {
log("markSelectedListItems()");//NOI18N
}
ListItem option = null;
Object nextItem = null;
Iterator items = listItems.iterator();
Iterator selected = null;
while (items.hasNext()) {
nextItem = items.next();
// If the next item is a selection group, we continue.
// Need to check this with the guidelines, perhaps
// you can select options too...
if (!(nextItem instanceof ListItem)) {
continue;
}
option = (ListItem) nextItem;
// By default, the option will not be marked as selected
option.setSelected(false);
if (DEBUG) {
log("\tItem value: " + option.getValue()); //NOI18N
log("\tItem type: " + //NOI18N
option.getValueObject().getClass().getName());
}
// There are no more selected items, continue with the
// next option
if (list.isEmpty()) {
if (DEBUG) {
log("No more selected items"); //NOI18N
}
continue;
}
// There are still selected items to account for
selected = list.iterator();
while (selected.hasNext()) {
if (processed) {
Object o = selected.next();
if (DEBUG) {
log("\tSelected object value: " + //NOI18N
String.valueOf(o));
log("\tSelected object type: " + //NOI18N
o.getClass().getName());
}
if (option.getValueObject().equals(o)) {
if (DEBUG) {
log("\tFound a match: " + //NOI18N
String.valueOf(o));
}
option.setSelected(true);
list.remove(o);
break;
}
} else {
String s = (String) selected.next();
if (s.equals(option.getValue())) {
if (DEBUG) {
log("\tFound a match: " + s); //NOI18N
}
option.setSelected(true);
list.remove(s);
break;
}
}
}
}
// At this point the selected list should be empty.
if (!list.isEmpty() && !Beans.isDesignTime()) {
String msg = MessageUtil.getMessage(
"com.sun.webui.jsf.resources.LogMessages", //NOI18N
"List.badValue",
new Object[]{getClientId(FacesContext.getCurrentInstance())});
//throw new FacesException(msg);
log(msg);
}
}
/* Add an option to the list */
protected ListItem createListItem(Option si) {
if (DEBUG) {
log("createListItem()");//NOI18N
}
String label = si.getLabel();
String valueString =
ConversionUtilities.convertValueToString(this, si.getValue());
if (label == null) {
label = valueString;
}
if (DEBUG) {
log("Label is " + label);
}
if ((label.length() * 1.5) > separatorLength) {
separatorLength = (int) (label.length() * 1.5);
}
ListItem listItem = new ListItem(si.getValue(), label, si.getDescription(),
si.isDisabled());
listItem.setValue(valueString);
if (si instanceof OptionTitle) {
listItem.setTitle(true);
}
return listItem;
}
//Labels
/**
* Return a component that implements the label for this ListSelector.
* If a facet named label is found
* that component is returned. Otherwise a Label component
* is returned. It is assigned the id
* getId() + "_label"
*
* If the facet is not defined then the returned Label
* component is re-intialized every time this method is called.
*
*
* @return a label component for this ListSelector
*/
public UIComponent getLabelComponent() {
if (DEBUG) {
log("getLabelComponent()"); //NOI18N
}
// Check if the page author has defined the facet
//
UIComponent labelComponent = getFacet(LABEL_FACET);
if (labelComponent != null) {
if (DEBUG) {
log("\tFound facet"); //NOI18N
}
return labelComponent;
}
// We need to allow an empty string label since this
// could mean that there is value binding and a
// message bundle hasn't loaded yet, but there
// is a value binding since the javax.el never returns
// null for a String binding.
//
String labelString = getLabel();
if (labelString == null /*|| labelString.length() == 0*/) {
return null;
}
// Return the private facet or create one, but initialize
// it every time
//
// We know it's a Label
//
Label label = (Label) ComponentUtilities.getPrivateFacet(this,
LABEL_FACET, true);
if (label == null) {
if (DEBUG) {
log("create Label"); //NOI18N
}
label = new Label();
label.setId(ComponentUtilities.createPrivateFacetId(this,
LABEL_FACET));
}
initLabelFacet(label, labelString, this.getClientId(getFacesContext()));
ComponentUtilities.putPrivateFacet(this, LABEL_FACET, label);
return label;
}
/**
* Initialize a label facet.
*
* @param label the Label instance
* @param labelString the label text.
* @param forComponent the component instance this label is for
*/
private void initLabelFacet(Label label, String labelString,
String forComponentId) {
if (DEBUG) {
log("initLabelFacet()"); //NOI18N
}
if (labelString == null || labelString.length() < 1) {
// TODO - maybe print a default?
// A Theme default value.
labelString = new String();
}
label.setText(labelString);
label.setLabelLevel(getLabelLevel());
if (!isReadOnly()) {
label.setFor(forComponentId);
}
}
/**
* Return a component that implements the read only value of this
* ListSelector.
* If a facet named readOnly is found
* that component is returned. Otherwise a StaticText component
* is returned. It is assigned the id
* getId() + "_readOnly"
*
* If the facet is not defined then the returned StaticText
* component is re-intialized every time this method is called.
*
*
* @return a component that represents the read only value of this ListSelector
*/
public UIComponent getReadOnlyValueComponent() {
if (DEBUG) {
log("getReadOnlyValueComponent()"); //NOI18N
}
// Check if the page author has defined the facet
//
UIComponent textComponent = getFacet(READONLY_FACET);
if (textComponent != null) {
if (DEBUG) {
log("\tFound facet"); //NOI18N
}
return textComponent;
}
// Just create it every time.
//
if (DEBUG) {
log("create StaticText"); //NOI18N
}
StaticText text = new StaticText();
text.setId(ComponentUtilities.createPrivateFacetId(this,
READONLY_FACET));
text.setParent(this);
FacesContext context = FacesContext.getCurrentInstance();
String readOnlyString = getValueAsReadOnly(context);
if (readOnlyString == null || readOnlyString.length() < 1) {
// TODO - maybe print a default?
readOnlyString = new String();
}
text.setText(readOnlyString);
return text;
}
/**
* Get the value (the object representing the selection(s)) of this
* component as a String array.
*
* @param context The FacesContext of the request
*/
public String[] getValueAsStringArray(FacesContext context) {
String[] values = null;
Object value = getSubmittedValue();
if (value != null) {
if (value instanceof String[]) {
return (String[]) value;
} else if (value instanceof String) {
values = new String[1];
values[0] = (String) value;
return values;
}
}
value = getValue();
if (value == null) {
return new String[0];
}
// No submitted value found - look for
if (valueTypeEvaluator.getValueType() == ValueType.NONE) {
return new String[0];
}
if (valueTypeEvaluator.getValueType() == ValueType.INVALID) {
return new String[0];
}
int counter = 0;
if (valueTypeEvaluator.getValueType() == ValueType.LIST) {
java.util.List list = (java.util.List) value;
counter = list.size();
values = new String[counter];
Iterator valueIterator = ((java.util.List) value).iterator();
String valueString = null;
counter = 0;
while (valueIterator.hasNext()) {
valueString = ConversionUtilities.convertValueToString(this, valueIterator.next());
values[counter++] = valueString;
}
} else if (valueTypeEvaluator.getValueType() == ValueType.ARRAY) {
counter = Array.getLength(value);
values = new String[counter];
Object valueObject = null;
String valueString = null;
for (int i = 0; i < counter; ++i) {
valueObject = Array.get(value, i);
valueString =
ConversionUtilities.convertValueToString(this, valueObject);
values[i] = valueString;
}
} else if (valueTypeEvaluator.getValueType() == ValueType.OBJECT) {
values = new String[1];
values[0] = ConversionUtilities.convertValueToString(this, value);
}
return values;
}
/**
* Returns the absolute ID of an HTML element suitable for use as
* the value of an HTML LABEL element's for attribute.
* If the ComplexComponent has sub-compoents, and one of
* the sub-components is the target of a label, if that sub-component
* is a ComplexComponent, then
* getLabeledElementId must called on the sub-component and
* the value returned. The value returned by this
* method call may or may not resolve to a component instance.
*
* @param context The FacesContext used for the request
* @return An abolute id suitable for the value of an HTML LABEL element's
* for attribute.
*/
public String getLabeledElementId(FacesContext context) {
// If this component has a label either as a facet or
// an attribute, return the id of the select list
// that will have the "LIST_ID" suffix. IF there is not
// label, then the select list id will be the component's
// client id.
//
// To ensure we get the right answer call getLabelComponent.
// This checks for a developer facet or the private label facet.
// It also checks the label attribute. This is better than
// relying on "getLabeledComponent" having been called
// like this method used to do.
//
String clntId = this.getClientId(context);
UIComponent labelComp = getLabelComponent();
if (labelComp == null) {
return clntId;
} else {
return clntId.concat(LIST_ID);
}
}
/**
* Returns the id of an HTML element suitable to
* receive the focus.
* If the ComplexComponent has sub-compoents, and one of
* the sub-components is to reveive the focus, if that sub-component
* is a ComplexComponent, then
* getFocusElementId must called on the sub-component and
* the value returned. The value returned by this
* method call may or may not resolve to a component instance.
*
* This implementations returns the value of
* getLabeledElementId.
*
*
* @param context The FacesContext used for the request
*/
public String getFocusElementId(FacesContext context) {
// For now just return the same id that is used for label.
//
return getLabeledElementId(context);
}
/**
* Implement this method so that it returns the DOM ID of the
* HTML element which should receive focus when the component
* receives focus, and to which a component label should apply.
* Usually, this is the first element that accepts input.
*
* @param context The FacesContext for the request
* @return The client id, also the JavaScript element id
*
* @deprecated
* @see #getLabeledElementId
* @see #getFocusElementId
*/
public String getPrimaryElementID(FacesContext context) {
return getLabeledElementId(context);
}
// remove me when the interface method goes.
/**
* Return a string suitable for displaying the value in read only mode.
* The default is to separate the list values with a comma.
*
* @param context The FacesContext
* @throws javax.faces.FacesException If the list items cannot be processed
*/
public String getValueAsReadOnly(FacesContext context, String separator) {
return "FIX ME!";//NOI18N
}
public boolean mainListSubmits() {
return true;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Tag attribute methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* If this attribute is true, the label is rendered above the
* component. If it is false, the label is rendered next to the
* component. The default is false.
*/
@Property(name = "labelOnTop", displayName = "Label on Top", category = "Appearance")
private boolean labelOnTop = false;
private boolean labelOnTop_set = false;
/**
* If this attribute is true, the label is rendered above the
* component. If it is false, the label is rendered next to the
* component. The default is false.
*/
public boolean isLabelOnTop() {
if (this.labelOnTop_set) {
return this.labelOnTop;
}
ValueExpression _vb = getValueExpression("labelOnTop");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return false;
} else {
return ((Boolean) _result).booleanValue();
}
}
return false;
}
/**
* If this attribute is true, the label is rendered above the
* component. If it is false, the label is rendered next to the
* component. The default is false.
* @see #isLabelOnTop()
*/
public void setLabelOnTop(boolean labelOnTop) {
this.labelOnTop = labelOnTop;
this.labelOnTop_set = true;
}
/**
* The number of items to display. The default value is 12.
*/
@Property(name = "rows", displayName = "Number of Items to Display", category = "Appearance",
editorClassName = "com.sun.rave.propertyeditors.IntegerPropertyEditor")
private int rows = Integer.MIN_VALUE;
private boolean rows_set = false;
/**
* The number of items to display. The default value is 12.
*/
public int getRows() {
if (this.rows_set) {
return this.rows;
}
ValueExpression _vb = getValueExpression("rows");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return Integer.MIN_VALUE;
} else {
return ((Integer) _result).intValue();
}
}
return 12;
}
/**
* The number of items to display. The default value is 12.
* @see #getRows()
*/
public void setRows(int rows) {
this.rows = rows;
this.rows_set = true;
}
/**
* Flag indicating that items corresponding to
* com.sun.webui.jsf.model.Option that are defined
* inside a com.sun.webui.jsf.model.OptionGroup should be
* surrounded by separators inside the list. The default value is
* true. If false, no separators are shown. To manually specify the
* location of separators, set this flag to false and place
* instances of com.sun.webui.jsf.model.Separator between
* the relevant com.sun.webui.jsf.model.Option instances
* when specifying the items attribute.
*/
@Property(name = "separators", displayName = "Separators", category = "Appearance")
private boolean separators = false;
private boolean separators_set = false;
/**
* Flag indicating that items corresponding to
* com.sun.webui.jsf.model.Option that are defined
* inside a com.sun.webui.jsf.model.OptionGroup should be
* surrounded by separators inside the list. The default value is
* true. If false, no separators are shown. To manually specify the
* location of separators, set this flag to false and place
* instances of com.sun.webui.jsf.model.Separator between
* the relevant com.sun.webui.jsf.model.Option instances
* when specifying the items attribute.
*/
public boolean isSeparators() {
if (this.separators_set) {
return this.separators;
}
ValueExpression _vb = getValueExpression("separators");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return false;
} else {
return ((Boolean) _result).booleanValue();
}
}
return true;
}
/**
* Flag indicating that items corresponding to
* com.sun.webui.jsf.model.Option that are defined
* inside a com.sun.webui.jsf.model.OptionGroup should be
* surrounded by separators inside the list. The default value is
* true. If false, no separators are shown. To manually specify the
* location of separators, set this flag to false and place
* instances of com.sun.webui.jsf.model.Separator between
* the relevant com.sun.webui.jsf.model.Option instances
* when specifying the items attribute.
* @see #isSeparators()
*/
public void setSeparators(boolean separators) {
this.separators = separators;
this.separators_set = 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.
*/
@Property(name = "visible", displayName = "Visible", category = "Behavior")
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.
*/
@Override
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()
*/
@Override
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.labelOnTop = ((Boolean) _values[1]).booleanValue();
this.labelOnTop_set = ((Boolean) _values[2]).booleanValue();
this.rows = ((Integer) _values[3]).intValue();
this.rows_set = ((Boolean) _values[4]).booleanValue();
this.separators = ((Boolean) _values[5]).booleanValue();
this.separators_set = ((Boolean) _values[6]).booleanValue();
this.visible = ((Boolean) _values[7]).booleanValue();
this.visible_set = ((Boolean) _values[8]).booleanValue();
}
/**
* Save the state of this component.
*/
@Override
public Object saveState(FacesContext _context) {
Object _values[] = new Object[9];
_values[0] = super.saveState(_context);
_values[1] = this.labelOnTop ? Boolean.TRUE : Boolean.FALSE;
_values[2] = this.labelOnTop_set ? Boolean.TRUE : Boolean.FALSE;
_values[3] = new Integer(this.rows);
_values[4] = this.rows_set ? Boolean.TRUE : Boolean.FALSE;
_values[5] = this.separators ? Boolean.TRUE : Boolean.FALSE;
_values[6] = this.separators_set ? Boolean.TRUE : Boolean.FALSE;
_values[7] = this.visible ? Boolean.TRUE : Boolean.FALSE;
_values[8] = this.visible_set ? Boolean.TRUE : Boolean.FALSE;
return _values;
}
}