001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041: package com.sun.rave.web.ui.model;
042:
043: /**
044: * Use the OptionsTitle class to add a Title to a list or
045: * array of Options. The label text will be rendered marked by dashes.
046: * <p>
047: * Use this class instead of OptionTitle to indicate that no items have
048: * been selected from this list. This is important in cases where a list
049: * component like a DropDown or Listbox, may be bound to a null initial
050: * component value.
051: * </p><p>
052: * When these components are bound to a null value, especialy a DropDown
053: * where a value will always be submitted, it is not possible to
054: * detect without a special Option that no change has actually occurred
055: * and a user didn't explicitly select an option. This can
056: * result in an incorrect value change event and model update.
057: * </p><p>
058: * When an OptionTitle is the first option in an array or
059: * list of Option's assigned to the "items" property of a
060: * DropDown, OptionTitle's value will be submitted when the form
061: * is submitted, if a different option is not chosen by the user. When the
062: * submitted value is decoded, this value will be identified and will treat the
063: * submission of the DropDown as if it was not submitted.
064: * </p><p>
065: * This prevents a false update in the case where a user had not made
066: * any change at all and the initial value of the DropDown does not
067: * match the submitted value, such is the case when the initial value
068: * of the component is null.
069: * </p><p>
070: * OptionTitle is also useful for a Listbox where once an
071: * an item is selected it cannot be deselected. Using OptionTitle
072: * gives the user an opportunity to select it, thereby deselecting a
073: * previous selection. On form submit the list will appear as if nothing
074: * had been selected.
075: * </p><p>
076: * NOTE: Calling setValue on this class will not change its
077: * value. The label can be set.
078: * </p>
079: */
080: public class OptionTitle extends Option {
081:
082: public static final String NONESELECTED = "com_sun_rave_web_ui_NONESELECTED";
083:
084: public OptionTitle(String title) {
085: super (NONESELECTED, title); //NOI18N
086: }
087:
088: /*
089: public String getLabel() {
090:
091: // FIXME: The dash "look" should be part of the Theme
092: // ideally as a format String with one parameter.
093: //
094: String label = super.getLabel();
095: label = "— ".concat(label).concat(" —");
096: return label;
097: }
098: */
099:
100: /**
101: * The value will not be changed, if this method is called.
102: */
103: public void setValue(String value) {
104: }
105: }
|