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: * This interface describes a selectable item in the filehooser listbox.
045: * The item has 5 values which can be implemented based on the resource type
046: * in question:
047: * a) An Object representing the value of the item
048: * b) A key that will be used as the value of the <option> tag in the
049: * filechooser listbox
050: * c) A label that will be the label of the <option> tag described above.
051: * d) A boolean flag indicating whether the option should be disabled or not.
052: * e) A boolean flag indicating if the resource being represented by this
053: * item is a container resource or a child resource. In the realm of
054: * of File systems this would translate to directory and file respectively.
055: *
056: *
057: * @author deep
058: */
059:
060: public interface ResourceItem {
061:
062: /**
063: * Returns an object representing the value of this resource item.
064: * For the default case of the FileChooser this would be a File
065: * object.
066: *
067: * @return an object which is the value of the ResourceItem.
068: */
069: public Object getItemValue();
070:
071: /**
072: * Returns a String representing the item key.
073: *
074: *
075: * @return returns an object representing the resource item
076: */
077: public String getItemKey();
078:
079: /**
080: * Set the item key.
081: *
082: *
083: * @param key - the resource item key
084: */
085: public void setItemKey(String key);
086:
087: /**
088: * Returns an object representing the resource item.
089: *
090: *
091: * @return returns an object representing the resource item
092: */
093: public String getItemLabel();
094:
095: /**
096: * Returns an object representing the resource item.
097: *
098: *
099: * @return returns an object representing the resource item
100: */
101: public void setItemLabel(String label);
102:
103: /**
104: * Returns an boolean value indicating if the item should be selectable
105: * in the filechooser's listbox.
106: *
107: *
108: * @return true if the item in the listbox should be disabled.
109: */
110: public boolean isItemDisabled();
111:
112: /**
113: * Sets the item disabled flag. If set to true the item should
114: * not be selectable.
115: *
116: *
117: *
118: * @enabled flag when set to true indicates item is not selectable.
119: */
120: public void setItemDisabled(boolean disabled);
121:
122: /**
123: * Returns a flag indicating if the resource item is a container. If true
124: * the item is a container item.
125: *
126: *
127: * @return true if the item is a container, false otherwise.
128: */
129: public boolean isContainerItem();
130:
131: public boolean equals(Object resourceItem);
132:
133: }
|