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-2006 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.websvc.design.configuration;
043:
044: import java.awt.Image;
045: import java.beans.PropertyChangeListener;
046:
047: /**
048: *
049: * @author Ajit Bhate
050: */
051: public interface WSConfiguration {
052:
053: public static String PROPERTY = "value";
054:
055: public static String PROPERTY_ENABLE = "enabled";
056:
057: /**
058: * Returns the user interface component for this WSConfiguration.
059: *
060: * @return the user interface component.
061: */
062: java.awt.Component getComponent();
063:
064: /**
065: * Returns the user-oriented description of this WSConfiguration, for use in
066: * tooltips in the usre interface.
067: *
068: * @return the human-readable description of this WSConfiguration.
069: */
070: String getDescription();
071:
072: /**
073: * Returns the display icon of this WSConfiguration.
074: *
075: * @return icon for this WSConfiguration.
076: */
077: Image getIcon();
078:
079: /**
080: * Returns the display name of this WSConfiguration.
081: *
082: * @return title for this WSConfiguration.
083: */
084: String getDisplayName();
085:
086: /**
087: * Called to apply changes made by the user
088: */
089: void set();
090:
091: /**
092: * Called to cancel changes made by the user
093: */
094: void unset();
095:
096: /**
097: * Used to determine if a functionality is active.
098: */
099: boolean isSet();
100:
101: /**
102: * Used to determine if a functionality is enabled.
103: */
104: boolean isEnabled();
105:
106: /**
107: * Allows to register for changes on the client.
108: */
109: public void registerListener(PropertyChangeListener listener);
110:
111: /**
112: * Required to unregister the listeners when not needed.
113: */
114: public void unregisterListener(PropertyChangeListener listener);
115:
116: }
|