diff options
author | cbateman | 2007-10-05 19:46:48 +0000 |
---|---|---|
committer | cbateman | 2007-10-05 19:46:48 +0000 |
commit | 871d5efb9d5aacb53706c38cf65f04c68c98e3c3 (patch) | |
tree | 069b4f0346519d8a0bc9d7971ac2ad23e71c8da2 /jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org | |
parent | 59358e3d83a8355e738a9e02fb2b9021e235263d (diff) | |
download | webtools.jsf-871d5efb9d5aacb53706c38cf65f04c68c98e3c3.tar.gz webtools.jsf-871d5efb9d5aacb53706c38cf65f04c68c98e3c3.tar.xz webtools.jsf-871d5efb9d5aacb53706c38cf65f04c68c98e3c3.zip |
Fixed warnings, removed dead code, reduced visibility of unnecessarily public things.
Diffstat (limited to 'jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org')
36 files changed, 491 insertions, 1483 deletions
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/ICommonConstants.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/ICommonConstants.java deleted file mode 100644 index f8ef8b560..000000000 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/ICommonConstants.java +++ /dev/null @@ -1,107 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2006 Sybase, Inc. and others. - * - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v1.0 - * which accompanies this distribution, and is available at - * http://www.eclipse.org/legal/epl-v10.html - * - * Contributors: - * Sybase, Inc. - initial API and implementation - *******************************************************************************/ -package org.eclipse.jst.jsf.common.ui; - -/** - * Common constants that would be used through the swad world. This might - * include file extensions, ids - * - * @author mengbo - */ -public interface ICommonConstants { - /** - * These are the defines for the logging preference pages. - */ - public static final String P_LOGGING = "logging"; // all logging - - // preferences will - // contain this string - // in the key. - - public static final String P_CONSOLE_LOGGING = "console.logging.on"; - - public static final String P_CONSOLE_LOG_LEVEL = "console.logging.max.level"; - - public static final String P_ECLIPSE_LOGGING = "eclipse.logging.on"; - - public static final String P_ECLIPSE_LOG_LEVEL = "eclipse.logging.max.level"; - - public static final String P_FILE_LOGGING = "file.logging.on"; - - public static final String P_FILE_LOG_LEVEL = "file.logging.max.level"; - - public static final String P_FILE_PATH = "file.logging.path"; - - public static final String P_FILE_CLEAR = "file.logging.startup.clear"; - - public static final String P_FILE_ROLLOVER_FREQUENCY = "file.logging.rollover.frequency"; - - public static final String P_REMOTE_LOGGING = "remote.logging.on"; - - public static final String P_REMOTE_LOG_LEVEL = "remote.logging.max.level"; - - public static final String P_REMOTE_HOST = "remote.logging.host"; - - public static final String P_REMOTE_PORT = "remote.logging.port"; - - /** Debug levels */ - public static final int DEBUG_LEVEL = 0; - - public static final int INFO_LEVEL = 1; - - public static final int WARN_LEVEL = 2; - - public static final int ERROR_LEVEL = 3; - - public static final int FATAL_LEVEL = 4; - - /** Rollover Frequency */ - public static final int DAILY_FREQ = 0; - - public static final int WEEKLY_FREQ = 1; - - public static final int MONTHLY_FREQ = 2; - - /** Sybase provided taglib id, defined in plugin.xml */ - public static final String SYBASE_TAGLIB_ID = "category_jsf"; - - /** DataWindow taglib id, defined in plugin.xml */ - public static final String DATAWINDOW_TAGLIB_ID = "category_datawindow"; - - /** Soap Service support category id, defined in plugin.xml of jmt */ - public static String SOAP_SERVICE_CATEGORY_ID = "category_soapservice"; - - /** An nature for jsf based webapp project */ - public static final String NATURE_WEBAPP = "org.eclipse.jst.pagedesigner.WebappNature"; - - public static final String XML_DECL = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"; - - /** default faces-config.xml file, for version 1.0 */ - public static final String FACES_CONFIG_10 = XML_DECL - + "<!DOCTYPE faces-config PUBLIC \"-//Sun Microsystems, Inc.//DTD JavaServer Faces Config 1.0//EN\" \"http://java.sun.com/dtd/web-facesconfig_1_0.dtd\">\n<faces-config/>"; - - /** default faces-config.xml file, for version 1.1 */ - public static final String FACES_CONFIG_11 = XML_DECL - + "<!DOCTYPE faces-config PUBLIC \"-//Sun Microsystems, Inc.//DTD JavaServer Faces Config 1.1//EN\" \"http://java.sun.com/dtd/web-facesconfig_1_1.dtd\">\n<faces-config/>"; - - /** default web.xml, for version 2.2 */ - public static final String WEBAPP_22 = XML_DECL - + "<!DOCTYPE web-app PUBLIC \"-//Sun Microsystems, Inc.//DTD Web Application 2.2//EN\" \"http://java.sun.com/j2ee/dtds/web-app_2_2.dtd\">"; - - /** default web.xml, for version 2.3 */ - public static final String WEBAPP_23 = XML_DECL - + "<!DOCTYPE web-app PUBLIC \"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN\" \"http://java.sun.com/dtd/web-app_2_3.dtd\">"; - - /** default web.xml, for version 2.4 */ - public static final String WEBAPP_24 = XML_DECL - + "<web-app xmlns=\"http://java.sun.com/xml/ns/j2ee\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" version=\"2.4\" xsi:schemaLocation=\"http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd\">"; -} diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/IFileFolderConstants.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/IFileFolderConstants.java index 34cc432f6..30e1ace3a 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/IFileFolderConstants.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/IFileFolderConstants.java @@ -16,132 +16,81 @@ package org.eclipse.jst.jsf.common.ui; * @version 1.5 */ public interface IFileFolderConstants { - public static final String STAR = "*"; + /** + * the dot character + */ public static final String DOT = "."; + /** + * the path separator + */ public static final String PATH_SEPARATOR = "/"; /** file extensions */ - public static final String EXT_APP = "app"; - + /** + * class file extension + */ public static final String EXT_CLASS = "class"; - public static final String EXT_DGM = "dgm"; - - public static final String EXT_GIF = "gif"; - - public static final String EXT_HTM = "htm"; - - public static final String EXT_HTML = "html"; - + /** + * jar file extension + */ public static final String EXT_JAR = "jar"; + /** + * java file extension + */ public static final String EXT_JAVA = "java"; - public static final String EXT_JPEG = "jpeg"; - - public static final String EXT_JPG = "jpg"; - - public static final String EXT_JSF = "jsf"; + /** + * jsp file extension + */ public static final String EXT_JSP = "jsp"; - public static final String EXT_JSV = "jsv"; - - public static final String EXT_JTPL = "jtpl"; - - public static final String EXT_JSPX = "jspx"; - - public static final String EXT_PAGEFLOW = "pageflow"; - - public static final String EXT_PBD = "pbd"; - - public static final String EXT_PBL = "pbl"; - - public static final String EXT_PNG = "png"; - - public static final String EXT_PSR = "psr"; - + /** + * properties file extension + */ public static final String EXT_PROPERTIES = "properties"; - public static final String EXT_PUL = "pul"; - - public static final String EXT_SRD = "srd"; - + /** + * taglib file extension + */ public static final String EXT_TAGLIB = "tld"; - public static final String EXT_TMPL = "tmpl"; - - public static final String EXT_WAR = "war"; - - public static final String EXT_XML = "xml"; - - public static final String EXT_ZIP = "zip"; - - public static final String EXT_WSDL = "wsdl"; - - /** files */ - public static final String FILE_BUILD_PROPERTIES = "build.properties"; - - public static final String FILE_FACES_CONFIG_XML = "faces-config.xml"; - - public static final String FILE_MANIFEST_MF = "MANIFEST.MF"; - - public static final String FILE_WEB_APP_23_DTD = "web-app_2_3.dtd"; - - public static final String FILE_WEB_FACESCONFIG_10_DTD = "web-facesconfig_1_0.dtd"; - + /** + * standard web.xml file name + */ public static final String FILE_WEB_XML = "web.xml"; - public static final String FILE_SYBASE_EASERVER_CONFIG_XML = "sybase-easerver-config.xml"; - /** folders */ - public static final String FOLDER_BIN = "bin"; + /** + * classes folder name + */ public static final String FOLDER_CLASS = "classes"; - public static final String FOLDER_DTD = "dtd"; - - public static final String FOLDER_GENERATED = "generated"; - + /** + * icons folder name + */ public static final String FOLDER_ICONS = "icons"; - public static final String FOLDER_IMAGES = "images"; - - public static final String FOLDER_LIB = "lib"; - + /** + * the meta-inf folder name + */ public static final String FOLDER_METAINF = "META-INF"; - public static final String FOLDER_PAGEFLOW = "pageflows"; - - public static final String FOLDER_PB = "pb"; - + /** + * the src folder name + */ public static final String FOLDER_SOURCE = "src"; - public static final String FOLDER_TEMPLATES = "templates"; - - public static final String FOLDER_TAGLIB = "tld"; - + /** + * the web-inf folder name + */ public static final String FOLDER_WEBINF = "WEB-INF"; - public static final String FOLDER_WEBROOT = "WebContent"; - - public static final String FOLDER_WIZARDS = "wizards"; - - public static final String FOLDER_WSDL = "wsdl"; - /** the webroot folder depth relative to the project */ public static final int WEBROOT_FOLDER_DEPTH = 2; - - /** - * @deprecated - */ - public static String DEFAULT_FACES_CONFIG_FILE_PATH = IFileFolderConstants.PATH_SEPARATOR - + IFileFolderConstants.FOLDER_WEBROOT - + IFileFolderConstants.PATH_SEPARATOR - + IFileFolderConstants.FOLDER_WEBINF - + IFileFolderConstants.PATH_SEPARATOR - + IFileFolderConstants.FILE_FACES_CONFIG_XML; - } diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/JSFUICommonPlugin.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/JSFUICommonPlugin.java index 8a82e5f25..39fb7f29d 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/JSFUICommonPlugin.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/JSFUICommonPlugin.java @@ -19,7 +19,6 @@ import java.util.MissingResourceException; import java.util.Properties; import java.util.ResourceBundle; -import org.eclipse.core.resources.IWorkspace; import org.eclipse.core.resources.ResourcesPlugin; import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.IStatus; @@ -31,9 +30,6 @@ import org.eclipse.jface.resource.ImageRegistry; import org.eclipse.jst.jsf.common.ui.internal.guiutils.Alerts; import org.eclipse.jst.jsf.common.ui.internal.logging.Logger; import org.eclipse.swt.graphics.Image; -import org.eclipse.swt.widgets.Display; -import org.eclipse.ui.IWorkbenchPage; -import org.eclipse.ui.IWorkbenchWindow; import org.eclipse.ui.plugin.AbstractUIPlugin; import org.osgi.framework.BundleContext; import org.osgi.framework.Version; @@ -41,10 +37,41 @@ import org.osgi.framework.Version; /** * The main plugin class to be used in the desktop. */ -public class JSFUICommonPlugin extends AbstractUIPlugin implements ICommonConstants { +public class JSFUICommonPlugin extends AbstractUIPlugin { // Properties contains general properties and defaults to preferences. private static final String PROPERTIES = "default.properties"; + // preferences will + // contain this string + // in the key. + private static final String P_CONSOLE_LOGGING = "console.logging.on"; + + private static final String P_CONSOLE_LOG_LEVEL = "console.logging.max.level"; + + private static final String P_ECLIPSE_LOGGING = "eclipse.logging.on"; + + private static final String P_ECLIPSE_LOG_LEVEL = "eclipse.logging.max.level"; + + private static final String P_FILE_LOGGING = "file.logging.on"; + + private static final String P_FILE_LOG_LEVEL = "file.logging.max.level"; + + private static final String P_FILE_PATH = "file.logging.path"; + + private static final String P_FILE_CLEAR = "file.logging.startup.clear"; + + private static final String P_FILE_ROLLOVER_FREQUENCY = "file.logging.rollover.frequency"; + + private static final int DEBUG_LEVEL = 0; + + private static final int INFO_LEVEL = 1; + + private static final int WARN_LEVEL = 2; + + private static final int ERROR_LEVEL = 3; + + private static final int FATAL_LEVEL = 4; + // What version of the platform are we on. private static boolean TWO_DOT_ONE; @@ -152,6 +179,7 @@ public class JSFUICommonPlugin extends AbstractUIPlugin implements ICommonConsta /** * Returns the shared instance. + * @return the plugin instance */ public static JSFUICommonPlugin getDefault() { return _plugin; @@ -168,6 +196,8 @@ public class JSFUICommonPlugin extends AbstractUIPlugin implements ICommonConsta /** * Returns a logger for the new class using this plugin for reference. + * @param theClass + * @return the logger */ // TODO: theClass is never used!! public static Logger getLogger(Class theClass) { @@ -176,6 +206,7 @@ public class JSFUICommonPlugin extends AbstractUIPlugin implements ICommonConsta /** * Returns the plugin's root logger + * @return the root logger */ public Logger getRootLogger() { return _log; @@ -184,7 +215,7 @@ public class JSFUICommonPlugin extends AbstractUIPlugin implements ICommonConsta /** * Returns this plugin's unique identifier * - * @retun this plugin's unique identifier + * @return this plugin's unique identifier * */ public static String getPluginId() { @@ -193,6 +224,7 @@ public class JSFUICommonPlugin extends AbstractUIPlugin implements ICommonConsta /** * Returns the plugin's resource bundle, + * @return the resource bundle */ public ResourceBundle getResourceBundle() { return _resourceBundle; @@ -201,6 +233,8 @@ public class JSFUICommonPlugin extends AbstractUIPlugin implements ICommonConsta /** * Returns the string from the plugin's resource bundle, or 'key' if not * found. + * @param key + * @return the resource string */ public static String getResourceString(String key) { ResourceBundle bundle = JSFUICommonPlugin.getDefault().getResourceBundle(); @@ -213,6 +247,7 @@ public class JSFUICommonPlugin extends AbstractUIPlugin implements ICommonConsta /** * Returns the plugin's descriptor's resource bundle, + * @return the bundle */ public ResourceBundle getPluginDecriptorBundle() { return Platform.getResourceBundle(getDefault().getBundle()); @@ -221,33 +256,13 @@ public class JSFUICommonPlugin extends AbstractUIPlugin implements ICommonConsta /** * Returns the plugin's default properties. These are normally used for * default preferences. + * @return the properties */ public Properties getProperties() { return _properties; } /** - * Returns the standard display to be used. The method first checks, if the - * thread calling this method has an associated dispaly. If so, this display - * is returned. Otherwise the method returns the default display. - */ - public static Display getStandardDisplay() { - Display display; - display = Display.getCurrent(); - if (display == null) { - display = Display.getDefault(); - } - return display; - } - - /** - * Returns the workspace instance. - */ - public static IWorkspace getWorkspace() { - return ResourcesPlugin.getWorkspace(); - } - - /** * Returns a shared image for the given name * <p> * Note: Images returned from this method will be automitically disposed of @@ -314,16 +329,6 @@ public class JSFUICommonPlugin extends AbstractUIPlugin implements ICommonConsta } /** - * Read a file resource. The file should contain any partial path and the - * filename from the plugin base. The caller is responsible for closing the - * file. - */ - public InputStream readFile(String file) throws MalformedURLException, - IOException { - return (new URL(_pluginBase, file)).openStream(); - } - - /** * Is this eclipse version 2.1 * * @return true if version is 2.1 @@ -350,34 +355,7 @@ public class JSFUICommonPlugin extends AbstractUIPlugin implements ICommonConsta return _version; } - /** - * Returns the active workbench window. - * - * @return the active workbench window. this can be null but I've never seen - * it. - */ - public static IWorkbenchWindow getActiveWorkbenchWindow() { - if (getDefault().getWorkbench() == null) { - return null; - } - return getDefault().getWorkbench().getActiveWorkbenchWindow(); - } - /** - * Returns the active workbench page. Note that the active page may not be - * the one that the user perceives as active in some situations so this - * method of obtaining the activate page should only be used if no other - * method is available. - * - * @return the active workbench page - */ - public static IWorkbenchPage getActivePage() { - IWorkbenchWindow window = getActiveWorkbenchWindow(); - if (window == null) { - return null; - } - return window.getActivePage(); - } /** * Initializes the preference controls to the default values. These values @@ -437,24 +415,4 @@ public class JSFUICommonPlugin extends AbstractUIPlugin implements ICommonConsta return ERROR_LEVEL; } - /** - * Converts the rollover frequency from string to int. The frequency - * defaults to DAILY. - * - * @param str - * String representation of rollover frequency - * @return integer representation of rollover frequency - */ - public int strToIntFrequency(String str) { - if (str == null) { - return DAILY_FREQ; - } - if (str.equalsIgnoreCase("WEEKLY")) { - return WEEKLY_FREQ; - } - if (str.equalsIgnoreCase("MONTHLY")) { - return MONTHLY_FREQ; - } - return DAILY_FREQ; - } } diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/AbstractClassButtonDialogField.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/AbstractClassButtonDialogField.java index d73a28d14..d7e3cb71c 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/AbstractClassButtonDialogField.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/AbstractClassButtonDialogField.java @@ -36,7 +36,7 @@ import org.eclipse.ui.forms.events.HyperlinkEvent; * @author mengbo * @version 1.5 */ -public abstract class AbstractClassButtonDialogField extends +/*package*/ abstract class AbstractClassButtonDialogField extends StringButtonDialogField { private IProject _project; @@ -50,10 +50,16 @@ public abstract class AbstractClassButtonDialogField extends private boolean _autoOpenResource = true; + /** + * @param autoOpenResource + */ public void setAutoOpenResource(boolean autoOpenResource) { _autoOpenResource = autoOpenResource; } + /** + * @param project + */ public AbstractClassButtonDialogField(IProject project) { super(null); this._project = project; @@ -107,8 +113,16 @@ public abstract class AbstractClassButtonDialogField extends } } + /** + * @return the interfaces + * TODO: the contract seems inconsistent + * as whether to return null or empty list when none + */ protected abstract List getImplementInterfaces(); + /** + * @return the java search scope to be used. Must not be null + */ protected abstract IJavaSearchScope getJavaSearchScope(); private void browseButtonPressed() { @@ -190,23 +204,17 @@ public abstract class AbstractClassButtonDialogField extends return _interfacesList; } + /** + * Sets (replaces) the interface list + * TODO: this list can have at most one element + * @param interfaceName + */ public void setInterface(String interfaceName) { _interfacesList = new ArrayList(); _interfacesList.add(interfaceName); } /** - * @param interfacesList - * The interfacesList to set. - */ - public void setInterfacesList(List interfacesList) { - // TODO:Now we can not find the IJavaSearchScope that support the - // Hierarchies for multi-types. - // We will support the multi-interfaces After resolve the problem. - this._interfacesList = interfacesList; - } - - /** * @return Returns the _type. */ public IType getType() { diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/BooleanComboDialogField.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/BooleanComboDialogField.java deleted file mode 100644 index b40bdaef7..000000000 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/BooleanComboDialogField.java +++ /dev/null @@ -1,42 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2006 Sybase, Inc. and others. - * - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v1.0 - * which accompanies this distribution, and is available at - * http://www.eclipse.org/legal/epl-v10.html - * - * Contributors: - * Sybase, Inc. - initial API and implementation - *******************************************************************************/ -package org.eclipse.jst.jsf.common.ui.internal.dialogfield; - - -/** - * @author mengbo - */ -public class BooleanComboDialogField extends ComboDialogField { - final public static int USE_YESNO = 0; - - final public static int USE_TRUEFALSE = 1; - - /** - * - * @param type - */ - public void setType(int type) { - if (type == USE_YESNO) { - setItems(new String[] { "", "yes", "no" }); - } else if (type == USE_TRUEFALSE) { - setItems(new String[] { "", "true", "false" }); - } - } - - /** - * @param flags - */ - public BooleanComboDialogField(int flags) { - super(flags); - setType(USE_TRUEFALSE); - } -} diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/ClasspathResourceButtonDialogField.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/ClasspathResourceButtonDialogField.java deleted file mode 100644 index a02a94f26..000000000 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/ClasspathResourceButtonDialogField.java +++ /dev/null @@ -1,89 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2006 Sybase, Inc. and others. - * - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v1.0 - * which accompanies this distribution, and is available at - * http://www.eclipse.org/legal/epl-v10.html - * - * Contributors: - * Sybase, Inc. - initial API and implementation - *******************************************************************************/ -package org.eclipse.jst.jsf.common.ui.internal.dialogfield; - -import org.eclipse.core.resources.IProject; -import org.eclipse.core.runtime.CoreException; -import org.eclipse.jdt.core.IJavaProject; -import org.eclipse.jdt.core.JavaCore; -import org.eclipse.jface.window.Window; -import org.eclipse.jst.jsf.common.ui.JSFUICommonPlugin; -import org.eclipse.jst.jsf.common.ui.IFileFolderConstants; -import org.eclipse.jst.jsf.common.ui.internal.dialogs.ResourceOnClasspathDialog; -import org.eclipse.swt.widgets.Shell; - -/** - * @author mengbo - */ -public class ClasspathResourceButtonDialogField extends StringButtonDialogField { - private IProject _project; - - private static final String[] PROPERTIES_FILES_SUFFIXS = new String[] { IFileFolderConstants.EXT_PROPERTIES }; //$NON-NLS-1$ - - public ClasspathResourceButtonDialogField(IProject project) { - this(null, project); - setStringButtonAdapter(new IStringButtonAdapter() { - public void changeControlPressed(DialogField field) { - browseButtonPressed(); - } - }); - } - - public ClasspathResourceButtonDialogField(IStringButtonAdapter adapter, - IProject project) { - super(adapter); - this._project = project; - } - - private void browseButtonPressed() { - Shell shell = getShell(); - ResourceOnClasspathDialog dialog = new ResourceOnClasspathDialog(shell, - getJavaProject()); - dialog.setTitle(JSFUICommonPlugin - .getResourceString("DialogField.ResourceButton.SelectFile"));//$NON-NLS-1$ - dialog.setSuffixs(PROPERTIES_FILES_SUFFIXS); - if (dialog.open() == Window.OK) { - String oldValue = getText(); - - String newValue = (String) dialog.getResult()[0]; - if (oldValue != newValue) { - setText(newValue); - } - } - } - - private IJavaProject getJavaProject() { - try { - if (_project != null && _project.hasNature(JavaCore.NATURE_ID)) { - return JavaCore.create(_project); - } - return null; - } catch (CoreException e) { - return null; - } - } - - /** - * @return Returns the project. - */ - public IProject getProject() { - return _project; - } - - /** - * @param project - * The project to set. - */ - public void setProject(IProject project) { - this._project = project; - } -} diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/ColorButtonDialogField.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/ColorButtonDialogField.java index 95eca3026..c4d2246d0 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/ColorButtonDialogField.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/ColorButtonDialogField.java @@ -71,6 +71,10 @@ public class ColorButtonDialogField extends StyleComboDialogField { private ColorPalette _colorPalette; + /** + * @param flags + * @param colorPalette + */ public ColorButtonDialogField(int flags, ColorPalette colorPalette) { super(flags); _buttonEnabled = true; @@ -149,6 +153,7 @@ public class ColorButtonDialogField extends StyleComboDialogField { /** * Sets the enable state of the button. + * @param enable */ public void enableButton(boolean enable) { if (isOkToUse(_button)) { @@ -159,10 +164,12 @@ public class ColorButtonDialogField extends StyleComboDialogField { /** * Creates or returns the created buttom widget. + * @param toolkit * * @param parent * The parent composite or <code>null</code> if the widget has * already been created. + * @return the button widget */ public Button getChangeControl(FormToolkit toolkit, Composite parent) { if (_button == null) { @@ -246,12 +253,7 @@ public class ColorButtonDialogField extends StyleComboDialogField { public int getNumberOfControls() { return 4; } - - public StyleCombo getTextControl(FormToolkit toolkit, Composite parent) { - return getComboControl(toolkit, parent); - } - - protected GridData gridDataForButton(int span) { + private GridData gridDataForButton(int span) { GridData gd = new GridData(); gd.horizontalAlignment = GridData.FILL; gd.grabExcessHorizontalSpace = false; diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/ComboDialogField.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/ComboDialogField.java index 66dd21786..11828162d 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/ComboDialogField.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/ComboDialogField.java @@ -12,7 +12,6 @@ package org.eclipse.jst.jsf.common.ui.internal.dialogfield; import java.util.Map; -import java.util.TreeMap; import java.util.Map.Entry; import org.eclipse.swt.SWT; @@ -59,6 +58,9 @@ public class ComboDialogField extends DialogFieldBase implements private Map _entryMap; + /** + * @param flags + */ public ComboDialogField(int flags) { super(); _text = ""; //$NON-NLS-1$ @@ -95,7 +97,7 @@ public class ComboDialogField extends DialogFieldBase implements return 3; } - protected static GridData gridDataForCombo(int span) { + private static GridData gridDataForCombo(int span) { GridData gd = new GridData(); gd.horizontalAlignment = GridData.FILL; gd.grabExcessHorizontalSpace = false; @@ -120,10 +122,12 @@ public class ComboDialogField extends DialogFieldBase implements /** * Creates or returns the created combo control. + * @param toolkit * * @param parent * The parent composite or <code>null</code> when the widget * has already been created. + * @return the custom combo control */ public CCombo getComboControl(FormToolkit toolkit, Composite parent) { if (_comboControl == null) { @@ -173,7 +177,7 @@ public class ComboDialogField extends DialogFieldBase implements return _comboControl; } - protected void handleDefaultSelection(SelectionEvent e) { + private void handleDefaultSelection(SelectionEvent e) { // commit value if (_pending) { _pending = false; @@ -181,7 +185,7 @@ public class ComboDialogField extends DialogFieldBase implements } } - protected void doFocusLost(FocusEvent e) { + private void doFocusLost(FocusEvent e) { if (_pending) { _pending = false; dialogFieldApplied(); @@ -221,15 +225,10 @@ public class ComboDialogField extends DialogFieldBase implements // ------ text access - /** - * Gets the combo items. - */ - public String[] getItems() { - return _items; - } /** * Sets the combo items. Triggers a dialog-changed event. + * @param items */ public void setItems(String[] items) { _items = items; @@ -240,19 +239,6 @@ public class ComboDialogField extends DialogFieldBase implements // dialogFieldChangedAndApplied(); } - public void setEntryMap(Map map) { - _entryMap = map; - if (_entryMap == null) { - _entryMap = new TreeMap(); - } - Entry[] entries = (Entry[]) _entryMap.entrySet().toArray(new Entry[0]); - String[] items = new String[entries.length]; - for (int i = 0; i < entries.length; i++) { - items[i] = entries[i].getValue().toString(); - } - setItems(items); - } - /** * Gets the text. */ @@ -271,6 +257,7 @@ public class ComboDialogField extends DialogFieldBase implements /** * Selects an item. + * @param index */ public void selectItem(int index) { if (isOkToUse(_comboControl)) { @@ -284,10 +271,6 @@ public class ComboDialogField extends DialogFieldBase implements dialogFieldChangedAndApplied(); } - public int getSelectionIndex() { - return _selectionIndex; - } - /** * Sets the text without triggering a dialog-changed event. */ diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/DialogField.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/DialogField.java index fe4029191..379e0a728 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/DialogField.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/DialogField.java @@ -13,6 +13,7 @@ package org.eclipse.jst.jsf.common.ui.internal.dialogfield; import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.Control; +import org.eclipse.swt.widgets.Shell; import org.eclipse.ui.forms.events.IHyperlinkListener; import org.eclipse.ui.forms.widgets.FormToolkit; @@ -35,38 +36,72 @@ public interface DialogField { /** * Sets the label of the dialog field. + * @param labeltext */ public abstract void setLabelText(String labeltext); // ------ change listener + /** + * Listener that is notified on a field change + * @param listener + */ public abstract void setDialogFieldChangeListener( IDialogFieldChangeListener listener); + /** + * Listener that is notified on a field apply + * @param listener + */ public abstract void setDialogFieldApplyListener( IDialogFieldApplyListener listener); // ------- focus management + /** + * Tries to set the focus to the dialog field. Returns <code>true</code> + * if the dialog field can take focus. To be reimplemented by dialog field + * implementors. + * @return true if dialog field can take focus + */ public abstract boolean setFocus(); - // ------- layout helpers + /** + * Creates all controls of the dialog field and fills it to a composite. The + * composite is assumed to have <code>MGridLayout</code> as layout. The + * dialog field will adjust its controls' spans to the number of columns + * given. To be reimplemented by dialog field implementors. + * @param toolkit + * @param parent + * @param nColumns + * @return the controls + */ public abstract Control[] doFillIntoGrid(FormToolkit toolkit, Composite parent, int nColumns); /** * Returns the number of columns of the dialog field. To be reimplemented by * dialog field implementors. + * @return the number of columns */ public abstract int getNumberOfControls(); // ------- ui creation + /** + * @param _formToolkit + * @param parent + * @return the label control + */ public abstract Control getLabelControl(FormToolkit _formToolkit, Composite parent); // --------- enable / disable management + /** + * @param enabled + */ public abstract void setEnabled(boolean enabled); /** * Gets the enable state of the dialog field. + * @return true if enabled is set */ public abstract boolean isEnabled(); @@ -97,7 +132,18 @@ public interface DialogField { */ public abstract void handleGrabHorizontal(); + /** + * @return true if is required field + */ public abstract boolean isRequired(); + /** + * @param toolTip + */ public abstract void setToolTip(String toolTip); + + /** + * @return the field's enclosing shell or null if none + */ + public Shell getShell(); } diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/DialogFieldBase.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/DialogFieldBase.java index bfc56d41c..f6e2de841 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/DialogFieldBase.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/DialogFieldBase.java @@ -64,7 +64,7 @@ public class DialogFieldBase implements DialogField { private Label _requiredLabel; - protected String _labelText; + private String _labelText; private IDialogFieldChangeListener _dialogFieldChangeListener; @@ -84,6 +84,9 @@ public class DialogFieldBase implements DialogField { private String toolTip; + /** + * default constructor + */ public DialogFieldBase() { _enabled = true; _label = null; @@ -130,7 +133,10 @@ public class DialogFieldBase implements DialogField { } } - protected Shell getShell() { + /** + * @return return the enclosing Shell or null if one cannot be determined + */ + public Shell getShell() { if (_label != null && !_label.isDisposed()) { return _label.getShell(); } else if (_hyperlink != null && !_hyperlink.isDisposed()) { @@ -188,11 +194,7 @@ public class DialogFieldBase implements DialogField { // ------- focus management - /** - * Tries to set the focus to the dialog field. Returns <code>true</code> - * if the dialog field can take focus. To be reimplemented by dialog field - * implementors. - */ + public boolean setFocus() { return false; } @@ -218,12 +220,6 @@ public class DialogFieldBase implements DialogField { // ------- layout helpers - /** - * Creates all controls of the dialog field and fills it to a composite. The - * composite is assumed to have <code>MGridLayout</code> as layout. The - * dialog field will adjust its controls' spans to the number of columns - * given. To be reimplemented by dialog field implementors. - */ public Control[] doFillIntoGrid(FormToolkit toolkit, Composite parent, int nColumns) { assertEnoughColumns(nColumns); @@ -244,6 +240,7 @@ public class DialogFieldBase implements DialogField { * * @param control * a control from which to obtain the current font + * @return the font metrics for control */ protected FontMetrics getDialogUnits(Control control) { if (_fontMetrics == null) { @@ -264,6 +261,10 @@ public class DialogFieldBase implements DialogField { return 1; } + /** + * @param span + * @return a new GridData for the horizontal 'span' value + */ protected static GridData gridDataForLabel(int span) { GridData gd = new GridData(GridData.HORIZONTAL_ALIGN_FILL); gd.horizontalSpan = span; @@ -322,6 +323,11 @@ public class DialogFieldBase implements DialogField { return control; } + /** + * @param _formToolkit + * @param parent + * @return get the Label control for required + */ public Control getRequiredLabelControl(FormToolkit _formToolkit, Composite parent) { if (_requiredLabel == null) { @@ -394,9 +400,11 @@ public class DialogFieldBase implements DialogField { /** * Creates a spacer control. + * @param toolkit * * @param parent * The parent composite + * @return a spacer control */ public Control createEmptySpace(FormToolkit toolkit, Composite parent) { return createEmptySpace(toolkit, parent, 1); @@ -405,9 +413,12 @@ public class DialogFieldBase implements DialogField { /** * Creates a spacer control with the given span. The composite is assumed to * have <code>MGridLayout</code> as layout. + * @param toolkit * * @param parent * The parent composite + * @param span + * @return a label that creates empty space */ public Control createEmptySpace(FormToolkit toolkit, Composite parent, int span) { @@ -430,6 +441,8 @@ public class DialogFieldBase implements DialogField { /** * Tests is the control is not <code>null</code> and not disposed. + * @param control + * @return true if the control is valid for use */ protected final boolean isOkToUse(Control control) { return (control != null) && !(control.isDisposed()); @@ -467,11 +480,17 @@ public class DialogFieldBase implements DialogField { return _enabled; } + /** + * @param comp + */ protected final void assertCompositeNotNull(Composite comp) { Assert.isNotNull(comp, "uncreated control requested with composite null"); //$NON-NLS-1$ } + /** + * @param nColumns + */ protected final void assertEnoughColumns(int nColumns) { Assert.isTrue(nColumns >= getNumberOfControls(), "given number of columns is too small"); //$NON-NLS-1$ @@ -520,10 +539,16 @@ public class DialogFieldBase implements DialogField { return _isRequired; } + /** + * @param isRequired + */ public void setRequired(boolean isRequired) { this._isRequired = isRequired; } + /** + * @return gthe tool tip text + */ protected String getToolTip() { return toolTip; } diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/DialogFieldGroupPage.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/DialogFieldGroupPage.java index 9839eb059..2e10f45e3 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/DialogFieldGroupPage.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/DialogFieldGroupPage.java @@ -22,12 +22,16 @@ import org.eclipse.swt.widgets.Composite; public class DialogFieldGroupPage extends WizardPage { private DialogFieldGroup _group; - IDialogFieldChangeListener _defaultChangeListener = new IDialogFieldChangeListener() { + private IDialogFieldChangeListener _defaultChangeListener = new IDialogFieldChangeListener() { public void dialogFieldChanged(DialogField field) { validate(); } }; + /** + * @param pageName + * @param section + */ public DialogFieldGroupPage(String pageName, DialogFieldGroup section) { super(pageName); _group = section; @@ -52,11 +56,18 @@ public class DialogFieldGroupPage extends WizardPage { this.setControl(container); } + /** + * @return the dialog field group + */ public DialogFieldGroup getDialogFieldGroup() { return _group; } - public void validate() { + /** + * validate all the dialog fields. Updates + * status line and sets page completion if there are no errors + */ + private void validate() { IStatus[] statuses = _group.validateDialogFields(); IStatus status = StatusUtil.getMostSevere(statuses); StatusUtil.applyToStatusLine(this, status); diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/DialogFieldResources.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/DialogFieldResources.java index 7ae2eab81..e58971cef 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/DialogFieldResources.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/DialogFieldResources.java @@ -23,7 +23,7 @@ import org.eclipse.jst.jsf.common.ui.internal.utils.ResourceUtils; * * @author mengbo */ -public class DialogFieldResources extends ResourceUtils { +/*package*/ class DialogFieldResources extends ResourceUtils { /** Create the logger for this class */ private static Logger _log = JSFUICommonPlugin .getLogger(DialogFieldResources.class); diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/DialogFieldWrapper.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/DialogFieldWrapper.java deleted file mode 100644 index a0bf3014a..000000000 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/DialogFieldWrapper.java +++ /dev/null @@ -1,345 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2006 Sybase, Inc. and others. - * - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v1.0 - * which accompanies this distribution, and is available at - * http://www.eclipse.org/legal/epl-v10.html - * - * Contributors: - * Sybase, Inc. - initial API and implementation - *******************************************************************************/ -package org.eclipse.jst.jsf.common.ui.internal.dialogfield; - -import org.eclipse.core.runtime.Assert; -import org.eclipse.swt.SWT; -import org.eclipse.swt.events.PaintEvent; -import org.eclipse.swt.events.PaintListener; -import org.eclipse.swt.events.SelectionEvent; -import org.eclipse.swt.events.SelectionListener; -import org.eclipse.swt.graphics.Image; -import org.eclipse.swt.graphics.Rectangle; -import org.eclipse.swt.layout.GridData; -import org.eclipse.swt.widgets.Button; -import org.eclipse.swt.widgets.Composite; -import org.eclipse.swt.widgets.Control; -import org.eclipse.ui.forms.events.IHyperlinkListener; -import org.eclipse.ui.forms.widgets.FormToolkit; - -/** - * This is a wrapper to a dialog field, by adding a small button at the end. The - * caller is responsible to provide the image or lable text and the button click - * handler. - * - * @author mengbo - * @version 1.5 - * see CellEditorWrapper TODO: what relation to page designer? - */ - -public class DialogFieldWrapper implements DialogField, ISupportTextValue { - private DialogField _wrappedDialogField; - - private Button _button; - - private boolean _buttonEnabled; - - private Image _buttonImage; - - private Image _disabledImage; - - private String _buttonLabel; - - private IStringButtonAdapter _adapter; - - /** - * - */ - public DialogFieldWrapper(DialogField field, Image image, - Image disabledImage) { - super(); - if (!(field instanceof ISupportTextValue)) { - throw new IllegalArgumentException( - "Field must be ISupportTextValue"); - } - _wrappedDialogField = field; - _buttonImage = image; - _disabledImage = disabledImage; - } - - /** - * - */ - public DialogFieldWrapper(DialogField field, String label) { - super(); - if (!(field instanceof ISupportTextValue)) { - throw new IllegalArgumentException( - "Field must be ISupportTextValue"); - } - _wrappedDialogField = field; - _buttonLabel = label; - } - - public void setButtonAdapter(IStringButtonAdapter adapter) { - this._adapter = adapter; - this.updateButtonControl(); - } - - /* - * (non-Javadoc) - * - * @see org.eclipse.jst.jsf.common.ui.internal.dialogfield.ISupportTextValue#setTextWithoutUpdate(java.lang.String) - */ - public void setTextWithoutUpdate(String value) { - ((ISupportTextValue) _wrappedDialogField).setTextWithoutUpdate(value); - } - - /* - * (non-Javadoc) - * - * @see org.eclipse.jst.jsf.common.ui.internal.dialogfield.ISupportTextValue#getText() - */ - public String getText() { - return ((ISupportTextValue) _wrappedDialogField).getText(); - } - - /* - * (non-Javadoc) - * - * @see org.eclipse.jst.jsf.common.ui.internal.dialogfield.ISupportTextValue#setText(java.lang.String) - */ - public void setText(String value) { - ((ISupportTextValue) _wrappedDialogField).setText(value); - } - - // -------------------------------------------------------------------------------------------- - // wrapped method to add the attached button - /* - * (non-Javadoc) - * - * @see org.eclipse.jst.jsf.common.ui.internal.dialogfield.DialogField#doFillIntoGrid(org.eclipse.ui.forms.widgets.FormToolkit, - * org.eclipse.swt.widgets.Composite, int) - */ - public Control[] doFillIntoGrid(FormToolkit toolkit, Composite parent, - int nColumns) { - Control[] wrappedControls = _wrappedDialogField.doFillIntoGrid(toolkit, - parent, nColumns - 1); - Control[] result = new Control[wrappedControls.length]; - - Control button = getButton(toolkit, parent); - button.setLayoutData(gridDataForButton(1)); - - System.arraycopy(wrappedControls, 0, result, 0, wrappedControls.length); - result[result.length - 1] = _button; - return result; - } - - /** - * @param span - * @return - */ - private GridData gridDataForButton(int span) { - GridData gd = new GridData(GridData.HORIZONTAL_ALIGN_FILL); - gd.horizontalSpan = span; - gd.widthHint = gd.heightHint = 18; - return gd; - } - - /** - * @param toolkit - * @param parent - * @return - */ - private Control getButton(FormToolkit toolkit, Composite parent) { - if (_button == null) { - Assert.isNotNull(parent, - "uncreated control requested with composite null"); //$NON-NLS-1$ - if (toolkit != null) { - _button = toolkit.createButton(parent, "", SWT.PUSH); - if (_buttonImage != null) { - _button.setImage(_buttonImage); - } else { - _button.setText(_buttonLabel); - } - } else { - _button = new Button(parent, SWT.PUSH); - if (_buttonImage != null) { - _button.setImage(_buttonImage); - } else { - _button.setText(_buttonLabel); - } - } - _button.addPaintListener(new PaintListener() { - public void paintControl(PaintEvent e) { - if (!_button.isEnabled() && _disabledImage != null) { - Rectangle buttonBounds = _button.getBounds(); - Rectangle imageBounds = _disabledImage.getBounds(); - e.gc.drawImage(_disabledImage, - (buttonBounds.width - imageBounds.width) / 2, - (buttonBounds.height - imageBounds.height) / 2); - } - } - }); - _button.setEnabled(isEnabled() && _buttonEnabled); - _button.addSelectionListener(new SelectionListener() { - public void widgetDefaultSelected(SelectionEvent e) { - buttonPressed(); - } - - public void widgetSelected(SelectionEvent e) { - buttonPressed(); - } - }); - - } - return _button; - } - - /* - * (non-Javadoc) - * - * @see org.eclipse.jst.jsf.common.ui.internal.dialogfield.DialogField#getLabelControl(org.eclipse.ui.forms.widgets.FormToolkit, - * org.eclipse.swt.widgets.Composite) - */ - public Control getLabelControl(FormToolkit _formToolkit, Composite parent) { - return _wrappedDialogField.getLabelControl(_formToolkit, parent); - } - - /* - * (non-Javadoc) - * - * @see org.eclipse.jst.jsf.common.ui.internal.dialogfield.IDialogField#setHyperLink(org.eclipse.ui.forms.events.IHyperlinkListener) - */ - public void setHyperLink(IHyperlinkListener listener) { - _wrappedDialogField.setHyperLink(listener); - } - - /* - * (non-Javadoc) - * - * @see org.eclipse.jst.jsf.common.ui.internal.dialogfield.IDialogField#setLabelText(java.lang.String) - */ - public void setLabelText(String labeltext) { - _wrappedDialogField.setLabelText(labeltext); - } - - /* - * (non-Javadoc) - * - * @see org.eclipse.jst.jsf.common.ui.internal.dialogfield.IDialogField#setDialogFieldChangeListener(org.eclipse.jst.jsf.common.ui.internal.dialogfield.IDialogFieldChangeListener) - */ - public void setDialogFieldChangeListener(IDialogFieldChangeListener listener) { - _wrappedDialogField.setDialogFieldChangeListener(listener); - } - - /* - * (non-Javadoc) - * - * @see org.eclipse.jst.jsf.common.ui.internal.dialogfield.IDialogField#setDialogFieldApplyListener(org.eclipse.jst.jsf.common.ui.internal.dialogfield.IDialogFieldApplyListener) - */ - public void setDialogFieldApplyListener(IDialogFieldApplyListener listener) { - _wrappedDialogField.setDialogFieldApplyListener(listener); - } - - /* - * (non-Javadoc) - * - * @see org.eclipse.jst.jsf.common.ui.internal.dialogfield.IDialogField#setFocus() - */ - public boolean setFocus() { - return _wrappedDialogField.setFocus(); - } - - /* - * (non-Javadoc) - * - * @see org.eclipse.jst.jsf.common.ui.internal.dialogfield.IDialogField#getNumberOfControls() - */ - public int getNumberOfControls() { - return _wrappedDialogField.getNumberOfControls() + 1; - } - - public void setButtonEnabled(boolean enabled) { - this._buttonEnabled = enabled; - updateButtonControl(); - } - - public boolean isButtonEnabled() { - return _buttonEnabled; - } - - /* - * (non-Javadoc) - * - * @see org.eclipse.jst.jsf.common.ui.internal.dialogfield.IDialogField#setEnabled(boolean) - */ - public void setEnabled(boolean enabled) { - _wrappedDialogField.setEnabled(enabled); - updateButtonControl(); - } - - /** - * - */ - private void updateButtonControl() { - if (this._button != null) { - this._button.setEnabled(this.isEnabled() && _buttonEnabled - && _adapter != null); - _button.redraw(); - } - } - - /* - * (non-Javadoc) - * - * @see org.eclipse.jst.jsf.common.ui.internal.dialogfield.IDialogField#isEnabled() - */ - public boolean isEnabled() { - return _wrappedDialogField.isEnabled(); - } - - /* - * (non-Javadoc) - * - * @see org.eclipse.jst.jsf.common.ui.internal.dialogfield.IDialogField#getAttachedData(java.lang.Object) - */ - public Object getAttachedData(Object key) { - return _wrappedDialogField.getAttachedData(key); - } - - /* - * (non-Javadoc) - * - * @see org.eclipse.jst.jsf.common.ui.internal.dialogfield.IDialogField#putAttachedData(java.lang.Object, - * java.lang.Object) - */ - public void putAttachedData(Object key, Object value) { - _wrappedDialogField.putAttachedData(key, value); - } - - protected void buttonPressed() { - if (_adapter != null) { - _adapter.changeControlPressed(this); - } - } - - /* - * (non-Javadoc) - * - * @see org.eclipse.jst.jsf.common.ui.internal.dialogfield.DialogField#handleGrabHorizontal() - */ - public void handleGrabHorizontal() { - _wrappedDialogField.handleGrabHorizontal(); - } - - public DialogField getWrappedDialogField() { - return _wrappedDialogField; - } - - public boolean isRequired() { - return _wrappedDialogField.isRequired(); - } - - public void setToolTip(String toolTip) { - _wrappedDialogField.setToolTip(toolTip); - } -} diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/IDialogFieldChangeListener.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/IDialogFieldChangeListener.java index 3a7345268..b5ead67e0 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/IDialogFieldChangeListener.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/IDialogFieldChangeListener.java @@ -21,6 +21,7 @@ public interface IDialogFieldChangeListener { /** * The dialog field has changed. + * @param field */ void dialogFieldChanged(DialogField field); } diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/IStringButtonAdapter.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/IStringButtonAdapter.java index 8fd7fe7b3..466e35578 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/IStringButtonAdapter.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/IStringButtonAdapter.java @@ -17,6 +17,8 @@ package org.eclipse.jst.jsf.common.ui.internal.dialogfield; */ public interface IStringButtonAdapter { + /** + * @param field + */ void changeControlPressed(DialogField field); - } diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/ISupportTextValue.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/ISupportTextValue.java index 3e2ea5acd..014752d66 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/ISupportTextValue.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/ISupportTextValue.java @@ -20,9 +20,18 @@ package org.eclipse.jst.jsf.common.ui.internal.dialogfield; * @version 1.5 */ public interface ISupportTextValue { + /** + * @param value + */ public void setTextWithoutUpdate(String value); + /** + * @return the text + */ public String getText(); + /** + * @param value + */ public void setText(String value); } diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/JavaClassWizard.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/JavaClassWizard.java index 4aa0808c4..745874044 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/JavaClassWizard.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/JavaClassWizard.java @@ -19,7 +19,6 @@ import org.eclipse.core.resources.IProject; import org.eclipse.core.resources.IResource; import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.IProgressMonitor; -import org.eclipse.core.runtime.jobs.ISchedulingRule; import org.eclipse.jdt.core.IJavaElement; import org.eclipse.jdt.core.IJavaProject; import org.eclipse.jdt.core.JavaCore; @@ -38,7 +37,7 @@ import org.eclipse.ui.wizards.newresource.BasicNewResourceWizard; /** * @author mengbo */ -public class JavaClassWizard extends Wizard { +/*package*/ class JavaClassWizard extends Wizard { private static String STORE_SECTION = "JavaClassWizard"; //$NON-NLS-1$ private JavaClassWizardPage _mainPage; @@ -53,14 +52,27 @@ public class JavaClassWizard extends Wizard { private boolean _autoOpenResource = true; + /** + * @param autoOpenResource + */ public void setAutoOpenResource(boolean autoOpenResource) { _autoOpenResource = autoOpenResource; } + /** + * @param project + * @param className + */ public JavaClassWizard(IProject project, String className) { this(project, className, null, null); } + /** + * @param project + * @param className + * @param superClass + * @param superInterfaces + */ public JavaClassWizard(IProject project, String className, String superClass, List superInterfaces) { this._project = project; @@ -146,7 +158,7 @@ public class JavaClassWizard extends Wizard { return true; } - protected void selectAndReveal(IResource newResource) { + private void selectAndReveal(IResource newResource) { BasicNewResourceWizard.selectAndReveal(newResource, getWorkbenchWindow()); } @@ -155,14 +167,13 @@ public class JavaClassWizard extends Wizard { return PlatformUI.getWorkbench().getActiveWorkbenchWindow(); } - protected ISchedulingRule getSchedulingRule() { - return _mainPage.getModifiedResource(); - } - - public String getClassName() { + private String getClassName() { return _className; } + /** + * @return the class name including args + */ public String getClassNameWithArgs() { if (_classArgs != null && _classArgs.length() > 0) { StringBuffer buffer = new StringBuffer(_className); diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/JavaClassWizardPage.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/JavaClassWizardPage.java index a99066659..b445c60c2 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/JavaClassWizardPage.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/JavaClassWizardPage.java @@ -17,14 +17,9 @@ import org.eclipse.core.resources.IFolder; import org.eclipse.core.resources.IProject; import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.IStatus; -import org.eclipse.core.runtime.Path; -import org.eclipse.jdt.core.IClassFile; -import org.eclipse.jdt.core.ICompilationUnit; -import org.eclipse.jdt.core.IJavaElement; import org.eclipse.jdt.core.IJavaProject; import org.eclipse.jdt.core.IPackageFragment; import org.eclipse.jdt.core.IPackageFragmentRoot; -import org.eclipse.jdt.core.IType; import org.eclipse.jdt.core.JavaConventions; import org.eclipse.jdt.core.JavaCore; import org.eclipse.jdt.core.JavaModelException; @@ -33,12 +28,12 @@ import org.eclipse.jdt.ui.wizards.NewClassWizardPage; /** * @author mengbo */ -public class JavaClassWizardPage extends NewClassWizardPage { +/*package*/ class JavaClassWizardPage extends NewClassWizardPage { private String _className; - private IProject _project; + private final IProject _project; - private InitialClassProperties _initialValues; + private final InitialClassProperties _initialValues; private IJavaProject _javaProject; @@ -46,26 +41,23 @@ public class JavaClassWizardPage extends NewClassWizardPage { private final static String SOURCE_COMPLIANCE_1_3 = JavaCore.VERSION_1_3; - class InitialClassProperties { + static class InitialClassProperties { // populate new wizard page - IType superClassType; + private String superClassName; - String superClassName; + private List interfacesName; - List interfacesName; + private String className; - String className; + private String classArgs; - String classArgs; + private String packageName; - String packageName; + private IPackageFragmentRoot packageFragmentRoot; - IPackageFragmentRoot packageFragmentRoot; + private IPackageFragment packageFragment; - IPackageFragment packageFragment; - - public InitialClassProperties() { - this.superClassType = null; + InitialClassProperties() { this.superClassName = ""; //$NON-NLS-1$ this.interfacesName = null; this.className = null; @@ -76,6 +68,12 @@ public class JavaClassWizardPage extends NewClassWizardPage { } } + /** + * @param project + * @param className + * @param superClassName + * @param interfacesName + */ public JavaClassWizardPage(IProject project, String className, String superClassName, List interfacesName) { super(); @@ -96,10 +94,17 @@ public class JavaClassWizardPage extends NewClassWizardPage { _initialValues.interfacesName = interfacesName; } + /** + * @param project + * @param className + */ public JavaClassWizardPage(IProject project, String className) { this(project, className, null, null); } + /** + * Call when page is added to wizard to initialize + */ public void init() { initializeExpectedValues(); initializeWizardPage(); @@ -167,12 +172,15 @@ public class JavaClassWizardPage extends NewClassWizardPage { if (_initialValues.superClassName == null) { _initialValues.superClassName = "java.lang.Object"; //$NON-NLS-1$ } - _initialValues.superClassType = findTypeForName(_initialValues.superClassName); +// _initialValues.superClassType = findTypeForName(_initialValues.superClassName); } catch (JavaModelException e) { e.printStackTrace();// PDEPlugin.logException(e); } } + /** + * initialize the wizard page + */ protected void initializeWizardPage() { setPackageFragmentRoot(_initialValues.packageFragmentRoot, true); setPackageFragment(_initialValues.packageFragment, true); @@ -191,24 +199,24 @@ public class JavaClassWizardPage extends NewClassWizardPage { || hasSuperClass, true); } - private IType findTypeForName(String typeName) throws JavaModelException { - if (typeName == null || typeName.length() == 0) { - return null; - } - IType type = null; - String fileName = typeName.replace('.', '/') + ".java"; //$NON-NLS-1$ - IJavaElement element = _javaProject.findElement(new Path(fileName)); - if (element == null) { - return null; - } - if (element instanceof IClassFile) { - type = ((IClassFile) element).getType(); - } else if (element instanceof ICompilationUnit) { - IType[] types = ((ICompilationUnit) element).getTypes(); - type = types[0]; - } - return type; - } +// private IType findTypeForName(String typeName) throws JavaModelException { +// if (typeName == null || typeName.length() == 0) { +// return null; +// } +// IType type = null; +// String fileName = typeName.replace('.', '/') + ".java"; //$NON-NLS-1$ +// IJavaElement element = _javaProject.findElement(new Path(fileName)); +// if (element == null) { +// return null; +// } +// if (element instanceof IClassFile) { +// type = ((IClassFile) element).getType(); +// } else if (element instanceof ICompilationUnit) { +// IType[] types = ((ICompilationUnit) element).getTypes(); +// type = types[0]; +// } +// return type; +// } /* * (non-Javadoc) @@ -228,6 +236,9 @@ public class JavaClassWizardPage extends NewClassWizardPage { } } + /** + * @return the class arguments or "" if not set + */ public String getClassArgs() { if (_initialValues.classArgs == null) { return ""; //$NON-NLS-1$ diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/JavaSearchScope.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/JavaSearchScope.java index 0cbcfe4c8..8ac58072d 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/JavaSearchScope.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/JavaSearchScope.java @@ -30,10 +30,10 @@ import org.eclipse.jst.jsf.common.ui.IFileFolderConstants; /** * @author mengbo */ -public class JavaSearchScope implements IJavaSearchScope { - private IProject _project; +/*package*/ class JavaSearchScope implements IJavaSearchScope { + private final IProject _project; - private String _superType; + private final String _superType; private HashSet _allowedTypeSet; @@ -41,6 +41,10 @@ public class JavaSearchScope implements IJavaSearchScope { private IProject[] _relativeProjects; + /** + * @param project + * @param superType + */ public JavaSearchScope(IProject project, String superType) { this._project = project; this._superType = superType; @@ -214,12 +218,4 @@ public class JavaSearchScope implements IJavaSearchScope { public String getSuperType() { return _superType; } - - /** - * @param superType - * The superType to set. - */ - public void setSuperType(String superType) { - this._superType = superType; - } } diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/JavaSearchScopeDecorator.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/JavaSearchScopeDecorator.java index 25ff03d02..94cd55ca1 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/JavaSearchScopeDecorator.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/JavaSearchScopeDecorator.java @@ -26,9 +26,13 @@ import org.eclipse.jdt.core.search.IJavaSearchScope; * @author mengbo * @version 1.5 */ -public class JavaSearchScopeDecorator implements IJavaSearchScope { +/*package*/ class JavaSearchScopeDecorator implements IJavaSearchScope { JavaSearchScope[] _scopes = new JavaSearchScope[0]; + /** + * @param project + * @param superTypes + */ public JavaSearchScopeDecorator(IProject project, List superTypes) { List scopeList = new ArrayList(); if (superTypes != null) { diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/JavaUIHelper.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/JavaUIHelper.java index 4847fb846..839a04ee2 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/JavaUIHelper.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/JavaUIHelper.java @@ -22,7 +22,6 @@ import org.eclipse.jdt.core.JavaCore; import org.eclipse.jdt.core.JavaModelException; import org.eclipse.jdt.core.search.IJavaSearchScope; import org.eclipse.jdt.core.search.SearchEngine; -import org.eclipse.jdt.ui.IJavaElementSearchConstants; import org.eclipse.jdt.ui.JavaUI; import org.eclipse.jface.dialogs.ProgressMonitorDialog; import org.eclipse.jst.jsf.common.ui.JSFUICommonPlugin; @@ -36,8 +35,12 @@ import org.eclipse.ui.ide.IDE; /** * @author mengbo */ -public class JavaUIHelper { - public static void doOpenClass(IProject project, String className) { +public final class JavaUIHelper { + /** + * @param project + * @param className + */ + static void doOpenClass(IProject project, String className) { String path = className.replace('.', '/') + ".java"; //$NON-NLS-1$ try { if (project.hasNature(JavaCore.NATURE_ID)) { @@ -61,7 +64,12 @@ public class JavaUIHelper { } } - public static boolean doesClassExist(IProject project, String className) { + /** + * @param project + * @param className + * @return true if the class exists in project + */ + static boolean doesClassExist(IProject project, String className) { String path = className.replace('.', '/') + ".java"; //$NON-NLS-1$ try { if (project.hasNature(JavaCore.NATURE_ID)) { @@ -79,7 +87,13 @@ public class JavaUIHelper { } } - public static SelectionDialog openSelectionDialog(Shell shell, + /** + * @param shell + * @param searchScope + * @param typeFlag + * @return the selection dialog + */ + static SelectionDialog openSelectionDialog(Shell shell, IJavaSearchScope searchScope, int typeFlag) { try { return JavaUI.createTypeDialog(shell, new ProgressMonitorDialog( @@ -90,20 +104,25 @@ public class JavaUIHelper { } } + /** + * @param shell + * @param project + * @param superType + * @param typeFlag + * @return the selection dialog + */ public static SelectionDialog openSelectionDialog(Shell shell, IProject project, String superType, int typeFlag) { IJavaSearchScope searchScope = findSearchScope(project, superType); return openSelectionDialog(shell, searchScope, typeFlag); } - public static SelectionDialog openSelectionDialog(Shell shell, - IProject project, String superType) { - IJavaSearchScope searchScope = findSearchScope(project, superType); - return openSelectionDialog(shell, searchScope, - IJavaElementSearchConstants.CONSIDER_ALL_TYPES); - } - - public static IJavaSearchScope findSearchScope(IProject project, + /** + * @param project + * @param superType + * @return the search scope + */ + static IJavaSearchScope findSearchScope(IProject project, String superType) { if (project != null) { if (superType == null || "".equals(superType)) { @@ -113,4 +132,9 @@ public class JavaUIHelper { } return SearchEngine.createWorkspaceScope(); } + + private JavaUIHelper() + { + // static helper, no instantiation + } } diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/LayoutUtil.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/LayoutUtil.java index 25e828068..2457cd153 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/LayoutUtil.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/LayoutUtil.java @@ -17,161 +17,26 @@ import org.eclipse.swt.SWT; import org.eclipse.swt.graphics.FontMetrics; import org.eclipse.swt.graphics.GC; import org.eclipse.swt.layout.GridData; -import org.eclipse.swt.layout.GridLayout; import org.eclipse.swt.widgets.Button; -import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.Control; -import org.eclipse.swt.widgets.Label; import org.eclipse.swt.widgets.Text; import org.eclipse.ui.forms.widgets.FormToolkit; -public class LayoutUtil { +/** + * A layout utility class + * + */ +public final class LayoutUtil { // The Text control looks higher then Button control when they have the same // height, // Increasing the height of 5 pixels will make them looks the same height. private final static int BUTTON_HEIGHT_ADJUSTMENT = 5; - public static Control createEmptySpace(FormToolkit kit, Composite parent, - int span) { - Label label; - if (kit != null) { - label = kit.createLabel(parent, ""); - } else { - label = new Label(parent, SWT.LEFT); - } - GridData gd = new GridData(); - gd.horizontalAlignment = GridData.BEGINNING; - gd.grabExcessHorizontalSpace = false; - gd.horizontalSpan = span; - gd.horizontalIndent = 0; - gd.widthHint = 0; - gd.heightHint = 0; - label.setLayoutData(gd); - return label; - } - - public static Composite createComposite(FormToolkit kit, Composite parent, - int span, int internalSpan) { - Composite c; - if (kit != null) { - c = kit.createComposite(parent); - kit.paintBordersFor(c); - } else { - c = new Composite(parent, SWT.NONE); - } - GridData gd = new GridData(); - gd.grabExcessHorizontalSpace = true; - gd.horizontalSpan = span; - gd.horizontalIndent = 0; - c.setLayoutData(gd); - - GridLayout layout = new GridLayout(); - layout.numColumns = internalSpan; - c.setLayout(layout); - - return c; - } - - /** - * Calculates the number of columns needed by field editors - */ - public static int getNumberOfColumns(DialogField[] editors) { - int nCulumns = 0; - for (int i = 0; i < editors.length; i++) { - nCulumns = Math.max(editors[i].getNumberOfControls(), nCulumns); - } - return nCulumns; - } - - /** - * Creates a composite and fills in the given editors. - * - * @param labelOnTop - * Defines if the label of all fields should be on top of the - * fields - */ - public static void doDefaultLayout(FormToolkit toolkit, Composite parent, - DialogField[] editors, boolean labelOnTop) { - doDefaultLayout(toolkit, parent, editors, labelOnTop, 0, 0, 0, 0); - } - - /** - * Creates a composite and fills in the given editors. - * - * @param labelOnTop - * Defines if the label of all fields should be on top of the - * fields - * @param minWidth - * The minimal width of the composite - * @param minHeight - * The minimal height of the composite - */ - public static void doDefaultLayout(FormToolkit toolkit, Composite parent, - DialogField[] editors, boolean labelOnTop, int minWidth, - int minHeight) { - doDefaultLayout(toolkit, parent, editors, labelOnTop, minWidth, - minHeight, 0, 0); - } - - /** - * Creates a composite and fills in the given editors. - * - * @param labelOnTop - * Defines if the label of all fields should be on top of the - * fields - * @param minWidth - * The minimal width of the composite - * @param minHeight - * The minimal height of the composite - * @param marginWidth - * The margin width to be used by the composite - * @param marginHeight - * The margin height to be used by the composite - * @deprecated - */ - public static void doDefaultLayout(FormToolkit toolkit, Composite parent, - DialogField[] editors, boolean labelOnTop, int minWidth, - int minHeight, int marginWidth, int marginHeight) { - int nCulumns = getNumberOfColumns(editors); - Control[][] controls = new Control[editors.length][]; - for (int i = 0; i < editors.length; i++) { - controls[i] = editors[i].doFillIntoGrid(toolkit, parent, nCulumns); - } - if (labelOnTop) { - nCulumns--; - modifyLabelSpans(controls, nCulumns); - } - GridLayout layout = new GridLayout(); - if (marginWidth != SWT.DEFAULT) { - layout.marginWidth = marginWidth; - } - if (marginHeight != SWT.DEFAULT) { - layout.marginHeight = marginHeight; - } - layout.numColumns = nCulumns; - parent.setLayout(layout); - } - - private static void modifyLabelSpans(Control[][] controls, int nCulumns) { - for (int i = 0; i < controls.length; i++) { - setHorizontalSpan(controls[i][0], nCulumns); - } - } /** - * Sets the span of a control. Assumes that GridData is used. + * @param control + * @param grab */ - public static void setHorizontalSpan(Control control, int span) { - Object ld = control.getLayoutData(); - if (ld instanceof GridData) { - ((GridData) ld).horizontalSpan = span; - } else if (span != 1) { - GridData gd = new GridData(); - gd.horizontalSpan = span; - control.setLayoutData(gd); - } - } - public static void setGrabHorizontal(Control control, boolean grab) { Object ld = control.getLayoutData(); if (ld instanceof GridData) { @@ -181,6 +46,8 @@ public class LayoutUtil { /** * Sets the width hint of a control. Assumes that GridData is used. + * @param control + * @param widthHint */ public static void setWidthHint(Control control, int widthHint) { Object ld = control.getLayoutData(); @@ -189,20 +56,13 @@ public class LayoutUtil { } } - /** - * Sets the heigthHint hint of a control. Assumes that GridData is used. - */ - public static void setHeigthHint(Control control, int heigthHint) { - Object ld = control.getLayoutData(); - if (ld instanceof GridData) { - ((GridData) ld).heightHint = heigthHint; - } - } /** * Sets the horizontal indent of a control. Assumes that GridData is used. + * @param control + * @param horizontalIndent */ - public static void setHorizontalIndent(Control control, int horizontalIndent) { + static void setHorizontalIndent(Control control, int horizontalIndent) { Object ld = control.getLayoutData(); if (ld instanceof GridData) { ((GridData) ld).horizontalIndent = horizontalIndent; @@ -211,6 +71,7 @@ public class LayoutUtil { /** * Sets the horizontal indent of a control. Assumes that GridData is used. + * @param control */ public static void setHorizontalGrabbing(Control control) { Object ld = control.getLayoutData(); @@ -221,8 +82,10 @@ public class LayoutUtil { /** * Returns a width hint for a button control. + * @param button + * @return the hint value */ - public static int getButtonWidthHint(Button button) { + static int getButtonWidthHint(Button button) { if (button.getFont().equals(JFaceResources.getDefaultFont())) button.setFont(JFaceResources.getDialogFont()); @@ -238,11 +101,16 @@ public class LayoutUtil { true).x); } - public static int getButtonHeightHint(FormToolkit toolkit, Text text) { + static int getButtonHeightHint(FormToolkit toolkit, Text text) { if (toolkit != null) { return text.computeSize(SWT.DEFAULT, SWT.DEFAULT, true).y + BUTTON_HEIGHT_ADJUSTMENT; } return text.computeSize(SWT.DEFAULT, SWT.DEFAULT, true).y; } + + private LayoutUtil() + { + // static utility class; no instantiation + } } diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/LocaleComboDialogField.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/LocaleComboDialogField.java deleted file mode 100644 index 0c7c6a17e..000000000 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/LocaleComboDialogField.java +++ /dev/null @@ -1,40 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2006 Sybase, Inc. and others. - * - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v1.0 - * which accompanies this distribution, and is available at - * http://www.eclipse.org/legal/epl-v10.html - * - * Contributors: - * Sybase, Inc. - initial API and implementation - *******************************************************************************/ -package org.eclipse.jst.jsf.common.ui.internal.dialogfield; - -import java.util.Arrays; -import java.util.Locale; - - -/** - * @author mengbo - */ -public class LocaleComboDialogField extends ComboDialogField { - private static String[] items; - static { - Locale[] locales = Locale.getAvailableLocales(); - items = new String[locales.length + 1]; - for (int i = 0, n = locales.length; i < n; i++) { - items[i] = locales[i].toString(); - } - items[locales.length] = ""; - Arrays.sort(items); - } - - /** - * @param flags - */ - public LocaleComboDialogField(int flags) { - super(flags); - setItems(items); - } -} diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/MultiTypeButtonDialogField.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/MultiTypeButtonDialogField.java deleted file mode 100644 index 7aa792e66..000000000 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/MultiTypeButtonDialogField.java +++ /dev/null @@ -1,77 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2006 Sybase, Inc. and others. - * - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v1.0 - * which accompanies this distribution, and is available at - * http://www.eclipse.org/legal/epl-v10.html - * - * Contributors: - * Sybase, Inc. - initial API and implementation - *******************************************************************************/ -package org.eclipse.jst.jsf.common.ui.internal.dialogfield; - -import java.util.ArrayList; -import java.util.Collections; -import java.util.List; - -import org.eclipse.core.resources.IProject; -import org.eclipse.jdt.core.search.IJavaSearchScope; - -/** - * @author mengbo - * @version 1.5 - */ -public class MultiTypeButtonDialogField extends AbstractClassButtonDialogField { - IJavaSearchScope _scope; - - /** - * @param project - */ - public MultiTypeButtonDialogField(IProject project) { - super(project); - } - - /* - * (non-Javadoc) - * - * @see org.eclipse.jst.jsf.common.ui.internal.dialogfield.AbstractClassButtonDialogField#getJavaSearchScope() - */ - protected IJavaSearchScope getJavaSearchScope() { - if (_scope == null) { - List list = new ArrayList(); - String superClassName = getSuperClassName(); - if (superClassName != null && !"".equalsIgnoreCase(superClassName)) { - list.add(getSuperClassName()); - } - list.addAll(getInterfacesList()); - _scope = new JavaSearchScopeDecorator(this.getProject(), list); - } - return _scope; - } - - /* - * (non-Javadoc) - * - * @see org.eclipse.jst.jsf.common.ui.internal.dialogfield.AbstractClassButtonDialogField#getImplementInterfaces() - */ - protected List getImplementInterfaces() { - List list = getInterfacesList(); - if (list.size() == 1) { - return list; - } - return Collections.EMPTY_LIST; - } - - /* - * (non-Javadoc) - * - * @see org.eclipse.jst.jsf.common.ui.internal.dialogfield.AbstractClassButtonDialogField#setProject(org.eclipse.core.resources.IProject) - */ - public void setProject(IProject project) { - if (project != getProject()) { - _scope = null; - } - super.setProject(project); - } -} diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/NumberDialogField.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/NumberDialogField.java deleted file mode 100644 index 8755c5acd..000000000 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/NumberDialogField.java +++ /dev/null @@ -1,45 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2006 Sybase, Inc. and others. - * - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v1.0 - * which accompanies this distribution, and is available at - * http://www.eclipse.org/legal/epl-v10.html - * - * Contributors: - * Sybase, Inc. - initial API and implementation - *******************************************************************************/ -package org.eclipse.jst.jsf.common.ui.internal.dialogfield; - -import org.eclipse.swt.events.VerifyEvent; -import org.eclipse.swt.events.VerifyListener; -import org.eclipse.swt.widgets.Composite; -import org.eclipse.swt.widgets.Control; -import org.eclipse.swt.widgets.Text; -import org.eclipse.ui.forms.widgets.FormToolkit; - -/** - * The text input only allows numbers - * - * @author mengbo - * @version 1.5 - */ -public class NumberDialogField extends StringDialogField { - public Control[] doFillIntoGrid(FormToolkit kit, Composite parent, - int nColumns) { - Control[] controls = super.doFillIntoGrid(kit, parent, nColumns); - - getTextControl(kit, parent).addVerifyListener(new VerifyListener() { - public void verifyText(VerifyEvent e) { - String str = ((Text) e.getSource()).getText(); - String newString = str.substring(0, e.start) + e.text - + str.substring(e.end, str.length()); - String regExpression = "^[1-9][0-9]*"; - e.doit = (newString.length() == 0 || newString - .matches(regExpression)); - } - }); - - return controls; - } -} diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/PackageButtonDialogField.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/PackageButtonDialogField.java deleted file mode 100644 index 223835238..000000000 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/PackageButtonDialogField.java +++ /dev/null @@ -1,254 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2006 Sybase, Inc. and others. - * - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v1.0 - * which accompanies this distribution, and is available at - * http://www.eclipse.org/legal/epl-v10.html - * - * Contributors: - * Sybase, Inc. - initial API and implementation - *******************************************************************************/ -package org.eclipse.jst.jsf.common.ui.internal.dialogfield; - -import org.eclipse.core.runtime.IPath; -import org.eclipse.core.runtime.IStatus; -import org.eclipse.jdt.core.IJavaElement; -import org.eclipse.jdt.core.IPackageFragment; -import org.eclipse.jdt.core.IPackageFragmentRoot; -import org.eclipse.jdt.core.JavaConventions; -import org.eclipse.jdt.core.JavaCore; -import org.eclipse.jdt.core.JavaModelException; -//import org.eclipse.jdt.internal.compiler.impl.CompilerOptions; -import org.eclipse.jdt.ui.JavaElementLabelProvider; -import org.eclipse.jface.window.Window; -import org.eclipse.jst.jsf.common.ui.JSFUICommonPlugin; -import org.eclipse.jst.jsf.common.ui.internal.logging.Logger; -import org.eclipse.ui.dialogs.ElementListSelectionDialog; - -/** - * This dialog field is used to select the package in the IPackageFragmentRoot - * - * - * @author mengbo - * @version 1.5 - */ -public class PackageButtonDialogField extends StringButtonDialogField { - /** Create the logger for this class */ - private static Logger _log = JSFUICommonPlugin - .getLogger(PackageButtonDialogField.class); - - /* - * package fragment root corresponding to the input type (can be null) - */ - private IPackageFragmentRoot _fCurrRoot; - - private IPackageFragment _fCurrPackage; - - private final static String SOURCE_COMPLIANCE_1_3 = JavaCore.VERSION_1_3; - - /** - * @param packageRoot - */ - public PackageButtonDialogField(IPackageFragmentRoot packageRoot) { - super(null); - setPackageFragmentRoot(packageRoot); - - setLabelText(DialogFieldResources.getInstance().getString( - "PackageButtonDialogField.package.label")); - - setButtonLabel(DialogFieldResources.getInstance().getString( - "PackageButtonDialogField.package.button")); - - setStringButtonAdapter(new IStringButtonAdapter() { - public void changeControlPressed(DialogField field) { - packageChangeControlPressed(field); - } - - }); - - } - - /** - * @param field - */ - protected void packageChangeControlPressed(DialogField field) { - IPackageFragment pack = choosePackage(); - if (pack != null) { - setPackageFragment(pack, true); - } - } - - /** - * Sets the current source folder (model and text field) to the given - * package fragment root. - * - * @param root - * The new root. - */ - public void setPackageFragmentRoot(IPackageFragmentRoot root) { - _fCurrRoot = root; - enableButton(getPackageFragmentRoot() != null); - } - - /** - * Returns the <code>IPackageFragmentRoot</code> that corresponds to the - * current value of the source folder field. - * - * @return the IPackageFragmentRoot or <code>null</code> if the current - * source folder value is not a valid package fragment root - * - */ - public IPackageFragmentRoot getPackageFragmentRoot() { - return _fCurrRoot; - } - - /** - * selection dialogs - */ - private IPackageFragment choosePackage() { - IPackageFragmentRoot froot = getPackageFragmentRoot(); - IJavaElement[] packages = null; - try { - if (froot != null && froot.exists()) { - packages = froot.getChildren(); - } - } catch (JavaModelException e) { - _log.error(e); - } - if (packages == null) { - packages = new IJavaElement[0]; - } - - ElementListSelectionDialog dialog = new ElementListSelectionDialog( - getShell(), new JavaElementLabelProvider( - JavaElementLabelProvider.SHOW_DEFAULT)); - dialog.setIgnoreCase(false); - dialog.setTitle(DialogFieldResources.getInstance().getString( - "PackageButtonDialogField.ChoosePackageDialog.title")); //$NON-NLS-1$ - dialog.setMessage(DialogFieldResources.getInstance().getString( - "PackageButtonDialogField.ChoosePackageDialog.description")); //$NON-NLS-1$ - dialog - .setEmptyListMessage(DialogFieldResources - .getInstance() - .getString( - "PackageButtonDialogField.ChoosePackageDialog.empty")); //$NON-NLS-1$ - dialog.setElements(packages); - IPackageFragment pack = getPackageFragment(); - if (pack != null) { - dialog.setInitialSelections(new Object[] { pack }); - } - - if (dialog.open() == Window.OK) { - return (IPackageFragment) dialog.getFirstResult(); - } - return null; - } - - /** - * Returns the package fragment corresponding to the current input. - * - * @return a package fragment or <code>null</code> if the input could not - * be resolved. - */ - public IPackageFragment getPackageFragment() { - return _fCurrPackage; - } - - /** - * Sets the package fragment to the given value. The method updates the - * model and the text of the control. - * - * @param pack - * the package fragment to be set - * @param canBeModified - * if <code>true</code> the package fragment is editable; - * otherwise it is read-only. - */ - public void setPackageFragment(IPackageFragment pack, boolean canBeModified) { - _fCurrPackage = pack; - String str = (pack == null) ? "" : pack.getElementName(); //$NON-NLS-1$ - setText(str); - setEnabled(canBeModified); - } - - /** - * Returns the text of the package input field. - * - * @return the text of the package input field - */ - public String getPackageText() { - return getText(); - } - - /** - * The method validates the package name and returns the status of the - * validation. The validation also updates the package fragment model. - * - * @return the status of the validation - */ - public IStatus getChangedStatus() { - StatusInfo status = new StatusInfo(); - - String packName = getPackageText(); - if (packName.length() > 0) { - IStatus val = JavaConventions.validatePackageName(packName,SOURCE_COMPLIANCE_1_3,SOURCE_COMPLIANCE_1_3); - if (val.getSeverity() == IStatus.ERROR) { - status - .setError(DialogFieldResources - .getInstance() - .getString( - "PackageButtonDialogField.error.InvalidPackageName", val.getMessage())); //$NON-NLS-1$ - return status; - } else if (val.getSeverity() == IStatus.WARNING) { - status - .setWarning(DialogFieldResources - .getInstance() - .getString( - "PackageButtonDialogField.warning.DiscouragedPackageName", val.getMessage())); //$NON-NLS-1$ - // continue - } - } else { - status - .setWarning(DialogFieldResources - .getInstance() - .getString( - "PackageButtonDialogField.warning.DefaultPackageDiscouraged")); //$NON-NLS-1$ - } - - IPackageFragmentRoot root = getPackageFragmentRoot(); - if (root != null) { - if (root.getJavaProject().exists() && packName.length() > 0) { - try { - IPath rootPath = root.getPath(); - IPath outputPath = root.getJavaProject() - .getOutputLocation(); - if (rootPath.isPrefixOf(outputPath) - && !rootPath.equals(outputPath)) { - // if the bin folder is inside of our root, don't allow - // to name a package - // like the bin folder - IPath packagePath = rootPath.append(packName.replace( - '.', '/')); - if (outputPath.isPrefixOf(packagePath)) { - status - .setError(DialogFieldResources - .getInstance() - .getString( - "PackageButtonDialogField.error.ClashOutputLocation")); //$NON-NLS-1$ - return status; - } - } - } catch (JavaModelException e) { - _log.error(e); - // let pass - } - } - - _fCurrPackage = root.getPackageFragment(packName); - } else { - status.setError(""); //$NON-NLS-1$ - } - return status; - } -} diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/RadiosDialogField.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/RadiosDialogField.java index cfe52bca0..1d2ef3eda 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/RadiosDialogField.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/RadiosDialogField.java @@ -89,6 +89,10 @@ public class RadiosDialogField extends DialogFieldBase { return 3; } + /** + * @param span + * @return the grid data + */ protected static GridData gridDataForGroup(int span) { GridData gd = new GridData(); gd.horizontalAlignment = GridData.FILL; @@ -111,6 +115,11 @@ public class RadiosDialogField extends DialogFieldBase { // ------- ui creation + /** + * @param toolkit + * @param parent + * @return the group composite + */ public Composite getGroup(FormToolkit toolkit, Composite parent) { if (_group == null) { assertCompositeNotNull(parent); @@ -167,6 +176,7 @@ public class RadiosDialogField extends DialogFieldBase { /** * Sets the text. Triggers a dialog-changed event. + * @param index */ public void setSelectedIndex(int index) { _selectIndex = index; @@ -186,6 +196,7 @@ public class RadiosDialogField extends DialogFieldBase { /** * Sets the text without triggering a dialog-changed event. + * @param index */ public void setSelectedIndexWithoutUpdate(int index) { _selectIndex = index; @@ -204,6 +215,9 @@ public class RadiosDialogField extends DialogFieldBase { } } + /** + * @return the index selected + */ public int getSelectedIndex() { return _selectIndex; } diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/Separator.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/Separator.java index 9b74c013a..caf5352f6 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/Separator.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/Separator.java @@ -27,6 +27,9 @@ public class Separator extends DialogFieldBase { private int _style; + /** + * Default constructor + */ public Separator() { this(SWT.NONE); } @@ -44,9 +47,13 @@ public class Separator extends DialogFieldBase { /** * Creates the separator and fills it in a MGridLayout. + * @param toolkit + * @param parent + * @param nColumns * * @param height * The heigth of the separator + * @return the controls or empty array */ public Control[] doFillIntoGrid(FormToolkit toolkit, Composite parent, int nColumns, int height) { @@ -73,6 +80,11 @@ public class Separator extends DialogFieldBase { return 1; } + /** + * @param span + * @param height + * @return the grid data + */ protected static GridData gridDataForSeperator(int span, int height) { GridData gd = new GridData(); gd.horizontalAlignment = GridData.FILL; @@ -86,12 +98,14 @@ public class Separator extends DialogFieldBase { /** * Creates or returns the created separator. + * @param toolkit * * @param parent * The parent composite or <code>null</code> if the widget has * already been created. + * @return the separator */ - public Control getSeparator(FormToolkit toolkit, Composite parent) { + private Control getSeparator(FormToolkit toolkit, Composite parent) { if (_separator == null) { assertCompositeNotNull(parent); if (toolkit != null) { diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/SourceFolderButtonDialogField.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/SourceFolderButtonDialogField.java index 03f9b12a7..1cef18121 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/SourceFolderButtonDialogField.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/SourceFolderButtonDialogField.java @@ -24,8 +24,8 @@ import org.eclipse.jdt.core.IJavaProject; import org.eclipse.jdt.core.IPackageFragmentRoot; import org.eclipse.jdt.core.JavaCore; import org.eclipse.jdt.core.JavaModelException; +import org.eclipse.jdt.ui.JavaElementComparator; import org.eclipse.jdt.ui.JavaElementLabelProvider; -import org.eclipse.jdt.ui.JavaElementSorter; import org.eclipse.jdt.ui.StandardJavaElementContentProvider; import org.eclipse.jface.viewers.ILabelProvider; import org.eclipse.jface.viewers.Viewer; @@ -200,7 +200,7 @@ public class SourceFolderButtonDialogField extends StringButtonDialogField { ElementTreeSelectionDialog dialog = new ElementTreeSelectionDialog( getShell(), labelProvider, provider); dialog.setValidator(validator); - dialog.setSorter(new JavaElementSorter()); + dialog.setComparator(new JavaElementComparator()); // HibernateWizardPage.ChooseSourceContainerDialog.Title = Folder // Selection dialog diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/StatusInfo.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/StatusInfo.java index c784b9641..8a8c9b75b 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/StatusInfo.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/StatusInfo.java @@ -19,11 +19,16 @@ import org.eclipse.jst.jsf.common.ui.JSFUICommonPlugin; * A settable IStatus. Can be an error, warning, info or ok. For error, info and * warning states, a message describes the problem. * + * TODO: couldn't have sub-classed Status? + * * @author mengbo * @version 1.5 */ -public class StatusInfo implements IStatus { +/*package*/ class StatusInfo implements IStatus { + /** + * a default status info for IStatus.OK + */ public static final IStatus OK_STATUS = new StatusInfo(); private String fStatusMessage; @@ -60,6 +65,7 @@ public class StatusInfo implements IStatus { /** * Returns if the status' severity is WARNING. + * @return true if severity is IStatus.WARNING */ public boolean isWarning() { return fSeverity == IStatus.WARNING; @@ -67,6 +73,7 @@ public class StatusInfo implements IStatus { /** * Returns if the status' severity is INFO. + * @return true if severity is INFO */ public boolean isInfo() { return fSeverity == IStatus.INFO; @@ -74,6 +81,7 @@ public class StatusInfo implements IStatus { /** * Returns if the status' severity is ERROR. + * @return true if severity is error */ public boolean isError() { return fSeverity == IStatus.ERROR; diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/StatusUtil.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/StatusUtil.java index 6c65dc009..22fe6d866 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/StatusUtil.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/StatusUtil.java @@ -27,6 +27,8 @@ public class StatusUtil { * returned: An error is more severe than a warning, and a warning is more * severe than ok. If the two stati have the same severity, the second is * returned. + * @param s1 + * @param s2 * * @return Could be null. */ @@ -47,6 +49,7 @@ public class StatusUtil { /** * Finds the most severe status from a array of stati. An error is more * severe than a warning, and a warning is more severe than ok. + * @param status * * @return could be null */ @@ -76,6 +79,8 @@ public class StatusUtil { /** * Applies the status to the status line of a dialog page. + * @param page + * @param status */ public static void applyToStatusLine(DialogPage page, IStatus status) { if (status == null) { diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/StringButtonDialogField.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/StringButtonDialogField.java index 2afe1f9bb..f750dafe1 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/StringButtonDialogField.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/StringButtonDialogField.java @@ -34,6 +34,9 @@ public class StringButtonDialogField extends StringDialogField { private boolean _buttonEnabled; + /** + * @param adapter + */ public StringButtonDialogField(IStringButtonAdapter adapter) { _stringButtonAdapter = adapter; _browseButtonLabel = JSFUICommonPlugin @@ -43,6 +46,7 @@ public class StringButtonDialogField extends StringDialogField { /** * Sets the label of the button. + * @param label */ public void setButtonLabel(String label) { _browseButtonLabel = label; @@ -87,6 +91,13 @@ public class StringButtonDialogField extends StringDialogField { return 4; } + /** + * @param toolkit + * @param button + * @param text + * @param span + * @return the grid data for the button + */ protected static GridData gridDataForButton(FormToolkit toolkit, Button button, Text text, int span) { GridData gd = new GridData(); @@ -103,10 +114,12 @@ public class StringButtonDialogField extends StringDialogField { /** * Creates or returns the created buttom widget. + * @param toolkit * * @param parent * The parent composite or <code>null</code> if the widget has * already been created. + * @return the button */ public Button getChangeControl(FormToolkit toolkit, Composite parent) { if (_browseButton == null) { @@ -137,6 +150,7 @@ public class StringButtonDialogField extends StringDialogField { /** * Sets the enable state of the button. + * @param enable */ public void enableButton(boolean enable) { if (isOkToUse(_browseButton)) { diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/StringDialogField.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/StringDialogField.java index 499ddbef6..c38ddb766 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/StringDialogField.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/StringDialogField.java @@ -37,18 +37,25 @@ public class StringDialogField extends DialogFieldBase implements private ModifyListener _modifyListener; - private int _numRows = 1; + private int _numRows; /** * whether there is change in the UI but not fire applied event yet. */ private boolean _pending = false; + /** + * default constructor + * numRows == 1 + */ public StringDialogField() { - super(); + this(1); _text = ""; //$NON-NLS-1$ } + /** + * @param numRows + */ public StringDialogField(int numRows) { super(); _text = ""; //$NON-NLS-1$ @@ -93,6 +100,11 @@ public class StringDialogField extends DialogFieldBase implements return gd; } + /** + * @param span + * @param heightHint + * @return the grid data for text + */ protected static GridData gridDataForText(int span, int heightHint) { GridData gd = new GridData(); gd.horizontalAlignment = GridData.FILL; @@ -103,6 +115,10 @@ public class StringDialogField extends DialogFieldBase implements return gd; } + /** + * @param span + * @return the grid data for text + */ protected static GridData gridDataForText(int span) { GridData gd = gridDataForText(span, -1); return gd; @@ -125,10 +141,12 @@ public class StringDialogField extends DialogFieldBase implements /** * Creates or returns the created text control. + * @param toolkit * * @param parent * The parent composite or <code>null</code> when the widget * has already been created. + * @return the text control */ public Text getTextControl(FormToolkit toolkit, Composite parent) { if (_textControl == null) { @@ -178,6 +196,9 @@ public class StringDialogField extends DialogFieldBase implements return _textControl; } + /** + * @param e + */ protected void doKeyReleased(KeyEvent e) { if (e.character == '\r') { // commit value @@ -188,6 +209,9 @@ public class StringDialogField extends DialogFieldBase implements } } + /** + * @param e + */ protected void doFocusLost(FocusEvent e) { if (_pending) { _pending = false; diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/StyleComboDialogField.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/StyleComboDialogField.java index a2079e56f..f549b716b 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/StyleComboDialogField.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/StyleComboDialogField.java @@ -36,6 +36,10 @@ import org.eclipse.swt.widgets.Display; import org.eclipse.ui.forms.FormColors; import org.eclipse.ui.forms.widgets.FormToolkit; +/** + * A dialog field for style combos + * + */ public class StyleComboDialogField extends DialogFieldBase implements ISupportTextValue { final static private int WIDTH_HINT = 10; @@ -58,14 +62,17 @@ public class StyleComboDialogField extends DialogFieldBase implements private String _defaultValue; - public String getDefaultValue() { - return _defaultValue; - } + /** + * @param defaultValue + */ public void setDefaultValue(String defaultValue) { this._defaultValue = defaultValue; } + /** + * @param flags + */ public StyleComboDialogField(int flags) { super(); _text = ""; //$NON-NLS-1$ @@ -102,6 +109,10 @@ public class StyleComboDialogField extends DialogFieldBase implements return 3; } + /** + * @param span + * @return the grid data for the combo + */ protected static GridData gridDataForCombo(int span) { GridData gd = new GridData(); gd.horizontalAlignment = GridData.FILL; @@ -127,10 +138,12 @@ public class StyleComboDialogField extends DialogFieldBase implements /** * Creates or returns the created combo control. + * @param toolkit * * @param parent * The parent composite or <code>null</code> when the widget * has already been created. + * @return the combo control */ public StyleCombo getComboControl(FormToolkit toolkit, final Composite parent) { @@ -211,6 +224,9 @@ public class StyleComboDialogField extends DialogFieldBase implements return _comboControl; } + /** + * @param e + */ protected void handleDefaultSelection(SelectionEvent e) { // commit value if (_pending) { @@ -219,6 +235,9 @@ public class StyleComboDialogField extends DialogFieldBase implements } } + /** + * @param e + */ protected void doFocusLost(FocusEvent e) { if (_pending) { _pending = false; @@ -260,14 +279,8 @@ public class StyleComboDialogField extends DialogFieldBase implements // ------ text access /** - * Gets the combo items. - */ - public String[] getItems() { - return _items; - } - - /** * Sets the combo items. Triggers a dialog-changed event. + * @param items */ public void setItems(String[] items) { _items = items; @@ -278,6 +291,9 @@ public class StyleComboDialogField extends DialogFieldBase implements // dialogFieldChangedAndApplied(); } + /** + * @param map + */ public void setEntryMap(Map map) { this._entryMap = map; if (_entryMap == null) { @@ -309,6 +325,7 @@ public class StyleComboDialogField extends DialogFieldBase implements /** * Selects an item. + * @param index */ public void selectItem(int index) { if (isOkToUse(_comboControl)) { @@ -322,6 +339,9 @@ public class StyleComboDialogField extends DialogFieldBase implements dialogFieldChangedAndApplied(); } + /** + * @return the selection index + */ public int getSelectionIndex() { return _selectionIndex; } diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/TypedElementSelectionValidator.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/TypedElementSelectionValidator.java index 6ec055ee6..8d0e09101 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/TypedElementSelectionValidator.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/TypedElementSelectionValidator.java @@ -24,7 +24,7 @@ import org.eclipse.ui.dialogs.ISelectionStatusValidator; * @author mengbo * @version 1.5 */ -public class TypedElementSelectionValidator implements +/*package*/ class TypedElementSelectionValidator implements ISelectionStatusValidator { private IStatus _fgErrorStatus = new StatusInfo(IStatus.ERROR, ""); //$NON-NLS-1$ diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/TypedViewerFilter.java b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/TypedViewerFilter.java index 584f99b24..52ecb6a2a 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/TypedViewerFilter.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common.ui/src/org/eclipse/jst/jsf/common/ui/internal/dialogfield/TypedViewerFilter.java @@ -22,7 +22,7 @@ import org.eclipse.jface.viewers.ViewerFilter; * @author mengbo * @version 1.5 */ -public class TypedViewerFilter extends ViewerFilter { +/*package*/ class TypedViewerFilter extends ViewerFilter { private Class[] _fAcceptedTypes; |