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 General
007: * Public License Version 2 only ("GPL") or the Common Development and Distribution
008: * License("CDDL") (collectively, the "License"). You may not use this file except in
009: * compliance with the License. You can obtain a copy of the License at
010: * http://www.netbeans.org/cddl-gplv2.html or nbbuild/licenses/CDDL-GPL-2-CP. See the
011: * License for the specific language governing permissions and limitations under the
012: * License. When distributing the software, include this License Header Notice in
013: * each file and include the License file at nbbuild/licenses/CDDL-GPL-2-CP. Sun
014: * designates this particular file as subject to the "Classpath" exception as
015: * provided by Sun in the GPL Version 2 section of the License file that
016: * accompanied this code. If applicable, add the following below the License Header,
017: * with the fields enclosed by brackets [] replaced by your own identifying
018: * information: "Portions Copyrighted [year] [name of copyright owner]"
019: *
020: * Contributor(s):
021: *
022: * The Original Software is NetBeans. The Initial Developer of the Original Software
023: * is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun Microsystems, Inc. All
024: * Rights Reserved.
025: *
026: * If you wish your version of this file to be governed by only the CDDL or only the
027: * GPL Version 2, indicate your decision by adding "[Contributor] elects to include
028: * this software in this distribution under the [CDDL or GPL Version 2] license." If
029: * you do not indicate a single choice of license, a recipient has the option to
030: * distribute your version of this file under either the CDDL, the GPL Version 2 or
031: * to extend the choice of license to its licensees as provided above. However, if
032: * you add GPL Version 2 code and therefore, elected the GPL Version 2 license, then
033: * the option applies only if the new code is made subject to such option by the
034: * copyright holder.
035: */
036:
037: package org.netbeans.installer.wizard.ui;
038:
039: import javax.swing.JComponent;
040: import org.netbeans.installer.utils.helper.swing.NbiButton;
041: import org.netbeans.installer.utils.helper.swing.NbiPanel;
042:
043: /**
044: * This class represents the UI of a {@link WizardComponent} for the
045: * {@link UiMode#SWING} UI mode.
046: *
047: * @author Kirill Sorokin
048: * @since 1.0
049: */
050: public abstract class SwingUi extends NbiPanel {
051: /**
052: * Returns the title of the component. The way the title is displayed is
053: * dependent on the container. A frame could expose the title in the windows
054: * heading, for example.
055: *
056: * @return Title of the component, or <code>null</code> if the component does
057: * not have a title.
058: */
059: public abstract String getTitle();
060:
061: /**
062: * Returns the description of the component. The way the description is
063: * displayed is dependent on the container.
064: *
065: * @return Description of the component, or <code>null</code> if the component
066: * does not have a description.
067: */
068: public abstract String getDescription();
069:
070: /**
071: * Hook, allowing the component's UI to execute some custom logic when the user
072: * activates the standard <code>Help</code> button. The expected behavior would
073: * be to display a help dialog which describes the required user input for the
074: * current component.
075: */
076: public abstract void evaluateHelpButtonClick();
077:
078: /**
079: * Hook, allowing the component's UI to execute some custom logic when the user
080: * activates the standard <code>Back</code> button. The expected behavior would
081: * be to call the {@link Wizard#previous()} method.
082: */
083: public abstract void evaluateBackButtonClick();
084:
085: /**
086: * Hook, allowing the component's UI to execute some custom logic when the user
087: * activates the standard <code>Next</code> button. The expected behavior would
088: * be to call the {@link Wizard#next()} method.
089: */
090: public abstract void evaluateNextButtonClick();
091:
092: /**
093: * Hook, allowing the component's UI to execute some custom logic when the user
094: * activates the standard <code>Cancel</code> button. The expected behavior
095: * would be to cancel the wizard execution.
096: */
097: public abstract void evaluateCancelButtonClick();
098:
099: /**
100: * Returns the button which should be activated when the user presses the
101: * <code>Enter</code> key.
102: *
103: * @return Default handler for the <code>Enter</code> key.
104: */
105: public abstract NbiButton getDefaultEnterButton();
106:
107: /**
108: * Returns the button which should be activated when the user presses the
109: * <code>Escape</code> key.
110: *
111: * @return Default handler for the <code>Escape</code> key.
112: */
113: public abstract NbiButton getDefaultEscapeButton();
114:
115: /**
116: * Returns the Swing component which should have focus when this UI is shown.
117: *
118: * @return Default focus owner for this UI.
119: */
120: public abstract JComponent getDefaultFocusOwner();
121: }
|