com.sun.webui.jsf.component.ListManager 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 java.util.Iterator;
import javax.faces.context.FacesContext;
import javax.faces.component.EditableValueHolder;
import javax.faces.component.UIComponent;
/**
* This interface is used to allow both list components which
* allow the user to select from a set of Options (e.g. Listbox,
* AddRemove) and list components which allow the user to edit
* a list to use the same renderer.
*
* @author avk
*/
//TODO: consider making this a base class instead. There
// is code which is shared between Selectors and Editable List,
// Orderable List. (getConvertedValue, getValueAsString, ...)
public interface ListManager extends EditableValueHolder, SelectorManager,
ComplexComponent {
/**
* Get an Iterator of the items to display. The items are of
* type com.sun.webui.jsf.model.list.ListItem and
* are an abstraction over different types of actual data
* to be used by the renderer
* @param rulerAtEnd If this attribute is set to true, the iterator will
* contain, as the last item, a disabled list option with a blank label whose
* sole function is to guarantee that the list stays the same size
* @return An Iterator of com.sun.webui.jsf.model.list.ListItem
*/
public Iterator getListItems(FacesContext context, boolean rulerAtEnd);
/**
* Retrieves the tooltip for the list
* @return A string with the text for the tool tip
*/
public String getToolTip();
/**
* Get the value of the component as a String array. The array consists
* of the converted value of each list item is shown.
* @param context The FacesContext of the request
* @return A string representation of the value
*/
public String[] getValueAsStringArray(FacesContext context);
/**
* Get the number of rows to display (the size of the HTML
* select element)
* @return The size of the list
*/
public int getRows();
/**
* Returns a UIComponent used to display the readonly value for this
* component
* @return a UIComponent used to display the readonly value for this
* component
*/
public UIComponent getReadOnlyValueComponent();
public boolean isVisible();
// return true if the select element associated with the component
// represents the value in the HTTP request.
public boolean mainListSubmits();
}