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:
042: package org.netbeans.modules.web.jsf.api.facesmodel;
043:
044: import org.netbeans.modules.web.jsf.impl.facesmodel.JSFConfigQNames;
045:
046: /**
047: * The icon type contains small-icon and large-icon elements
048: * that specify the file names for small and large GIF, JPEG,
049: * or PNG icon images used to represent the parent element in a
050: * GUI tool.
051: *
052: * The xml:lang attribute defines the language that the
053: * icon file names are provided in. Its value is "en" (English)
054: * by default
055: *
056: * @author Petr Pisl
057: */
058:
059: public interface Icon extends LangAttribute {
060:
061: public static final String SMALL_ICON = JSFConfigQNames.SMALL_ICON
062: .getLocalName();
063: public static final String LARGE_ICON = JSFConfigQNames.LARGE_ICON
064: .getLocalName();
065:
066: /**
067: * The small-icon element contains the name of a file
068: * containing a small (16 x 16) icon image. The file
069: * name is a relative path within the Deployment
070: * Component's Deployment File.
071: *
072: * The image may be in the GIF, JPEG, or PNG format.
073: * The icon can be used by tools.
074: * @return the path to the small icon
075: */
076: public String getSmallIcon();
077:
078: /**
079: * The small-icon element contains the name of a file
080: * containing a small (16 x 16) icon image. The file
081: * name is a relative path within the Deployment
082: * Component's Deployment File.
083: *
084: * The image may be in the GIF, JPEG, or PNG format.
085: * The icon can be used by tools.
086: * @param smallIcon the file name
087: */
088: public void setSmallIcon(String smallIcon);
089:
090: /**
091: * The large-icon element contains the name of a file
092: * containing a large
093: * (32 x 32) icon image. The file name is a relative
094: * path within the Deployment Component's Deployment
095: * File.
096: *
097: * The image may be in the GIF, JPEG, or PNG format.
098: * The icon can be used by tools.
099: * @return the path to the large icon
100: */
101: public String getLargeIcon();
102:
103: /**
104: * The large-icon element contains the name of a file
105: * containing a large
106: * (32 x 32) icon image. The file name is a relative
107: * path within the Deployment Component's Deployment
108: * File.
109: *
110: * The image may be in the GIF, JPEG, or PNG format.
111: * The icon can be used by tools.
112: * @param largeIcon the path to the large icon
113: */
114: public void setLargeIcon(String largeIcon);
115:
116: }
|