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.vmd.midp.propertyeditors.api.usercode;
043:
044: import javax.swing.JComponent;
045: import javax.swing.JRadioButton;
046: import org.netbeans.modules.vmd.api.model.PropertyValue;
047:
048: /**
049: * This class represents an UI and logical element of PropertyEditorUserCode.
050: *
051: * @author Anton Chechel
052: */
053: public interface PropertyEditorElement {
054:
055: /**
056: * Updates state of the element by given property value
057: * @param PropertyValue value which represents current state of model
058: */
059: void updateState(PropertyValue value);
060:
061: /**
062: * Sets text from which element can set property value. Another way is to use
063: * DesignPropertyEditor.customEditorOKButtonPressed()
064: *
065: * @param PropertyValue value which represents current state of model
066: */
067: void setTextForPropertyValue(String text);
068:
069: /**
070: * Returns text from element what represents property value's state
071: *
072: * @return String text
073: */
074: String getTextForPropertyValue();
075:
076: /**
077: * Returns custom editor component for element
078: *
079: * @return JComponent custom editor
080: */
081: JComponent getCustomEditorComponent();
082:
083: /**
084: * Returns radio button component for element
085: *
086: * @return JRadioButton
087: */
088: JRadioButton getRadioButton();
089:
090: /**
091: * Returns boolean value whether this element should be active by default
092: * and radio button selected
093: *
094: * @return booleans is initially selected
095: */
096: boolean isInitiallySelected();
097:
098: /**
099: * Returns boolean value whether this element could be vertically resized.
100: * For example for simple elements like JComboBox or JTextField it should return
101: * false, but for complex panel which encapsulates a lot of components or for
102: * big components like JEditorPane it should return true.
103: *
104: * @return booleans is element vertically resizable
105: */
106: boolean isVerticallyResizable();
107: }
|