diff options
| author | Andrey Loskutov | 2017-01-04 18:15:03 +0000 |
|---|---|---|
| committer | Andrey Loskutov | 2017-01-04 18:24:07 +0000 |
| commit | 8abfce119e3408a32d261fcce5da53387320e5c4 (patch) | |
| tree | 5614a24a8b868c21f5d693910da26fdfe8426225 /org.eclipse.ui.intro | |
| parent | 680afa3b0b468c98737bb31e79cd9d2349cf508f (diff) | |
| download | eclipse.platform.ua-8abfce119e3408a32d261fcce5da53387320e5c4.tar.gz eclipse.platform.ua-8abfce119e3408a32d261fcce5da53387320e5c4.tar.xz eclipse.platform.ua-8abfce119e3408a32d261fcce5da53387320e5c4.zip | |
Bug 509946 - [clean up] fix trailing spaces in platform help once andY20170112-1300Y20170112-1000Y20170105-1040Y20170105-1000I20170112-0245I20170112-0200I20170111-2000I20170111-0200I20170110-2000I20170109-2000I20170108-2000I20170107-2000I20170106-2000I20170105-2000I20170105-0320I20170105-0230I20170104-2000
forever
Applied Cleanup-> Remove trailing spaces on all help projects. Only
those four projects had whitespace issues: org.eclipse.help.ui,
org.eclipse.ui.intro.quicklinks, org.eclipse.ui.intro.universal,
org.eclipse.ui.intro. Same four projects haven't automatic save actions
enabled, therefore I've updated the settings too.
Change-Id: If7f896ab4ceb6587af6f211057729f443fd016cb
Signed-off-by: Andrey Loskutov <loskutov@gmx.de>
Diffstat (limited to 'org.eclipse.ui.intro')
71 files changed, 757 insertions, 700 deletions
diff --git a/org.eclipse.ui.intro/.settings/org.eclipse.jdt.ui.prefs b/org.eclipse.ui.intro/.settings/org.eclipse.jdt.ui.prefs index 30342114f..7ef179682 100644 --- a/org.eclipse.ui.intro/.settings/org.eclipse.jdt.ui.prefs +++ b/org.eclipse.ui.intro/.settings/org.eclipse.jdt.ui.prefs @@ -1,6 +1,63 @@ -#Sat Nov 12 22:58:47 EST 2005 eclipse.preferences.version=1 +editor_save_participant_org.eclipse.jdt.ui.postsavelistener.cleanup=true formatter_profile=_UA formatter_settings_version=9 internal.default.compliance=user org.eclipse.jdt.ui.text.custom_code_templates=<?xml version\="1.0" encoding\="UTF-8"?><templates/> +sp_cleanup.add_default_serial_version_id=true +sp_cleanup.add_generated_serial_version_id=false +sp_cleanup.add_missing_annotations=true +sp_cleanup.add_missing_deprecated_annotations=true +sp_cleanup.add_missing_methods=false +sp_cleanup.add_missing_nls_tags=false +sp_cleanup.add_missing_override_annotations=true +sp_cleanup.add_missing_override_annotations_interface_methods=true +sp_cleanup.add_serial_version_id=false +sp_cleanup.always_use_blocks=true +sp_cleanup.always_use_parentheses_in_expressions=false +sp_cleanup.always_use_this_for_non_static_field_access=false +sp_cleanup.always_use_this_for_non_static_method_access=false +sp_cleanup.convert_functional_interfaces=false +sp_cleanup.convert_to_enhanced_for_loop=false +sp_cleanup.correct_indentation=false +sp_cleanup.format_source_code=false +sp_cleanup.format_source_code_changes_only=false +sp_cleanup.insert_inferred_type_arguments=false +sp_cleanup.make_local_variable_final=true +sp_cleanup.make_parameters_final=false +sp_cleanup.make_private_fields_final=true +sp_cleanup.make_type_abstract_if_missing_method=false +sp_cleanup.make_variable_declarations_final=false +sp_cleanup.never_use_blocks=false +sp_cleanup.never_use_parentheses_in_expressions=true +sp_cleanup.on_save_use_additional_actions=true +sp_cleanup.organize_imports=false +sp_cleanup.qualify_static_field_accesses_with_declaring_class=false +sp_cleanup.qualify_static_member_accesses_through_instances_with_declaring_class=true +sp_cleanup.qualify_static_member_accesses_through_subtypes_with_declaring_class=true +sp_cleanup.qualify_static_member_accesses_with_declaring_class=false +sp_cleanup.qualify_static_method_accesses_with_declaring_class=false +sp_cleanup.remove_private_constructors=true +sp_cleanup.remove_redundant_type_arguments=true +sp_cleanup.remove_trailing_whitespaces=true +sp_cleanup.remove_trailing_whitespaces_all=true +sp_cleanup.remove_trailing_whitespaces_ignore_empty=false +sp_cleanup.remove_unnecessary_casts=true +sp_cleanup.remove_unnecessary_nls_tags=false +sp_cleanup.remove_unused_imports=true +sp_cleanup.remove_unused_local_variables=false +sp_cleanup.remove_unused_private_fields=true +sp_cleanup.remove_unused_private_members=false +sp_cleanup.remove_unused_private_methods=true +sp_cleanup.remove_unused_private_types=true +sp_cleanup.sort_members=false +sp_cleanup.sort_members_all=false +sp_cleanup.use_anonymous_class_creation=false +sp_cleanup.use_blocks=false +sp_cleanup.use_blocks_only_for_return_and_throw=false +sp_cleanup.use_lambda=true +sp_cleanup.use_parentheses_in_expressions=false +sp_cleanup.use_this_for_non_static_field_access=false +sp_cleanup.use_this_for_non_static_field_access_only_if_necessary=true +sp_cleanup.use_this_for_non_static_method_access=false +sp_cleanup.use_this_for_non_static_method_access_only_if_necessary=true diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/FontSelection.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/FontSelection.java index 8d4326d91..6d7a51e0c 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/FontSelection.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/FontSelection.java @@ -4,7 +4,7 @@ * 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: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -22,23 +22,23 @@ import org.eclipse.swt.graphics.FontData; import org.osgi.service.prefs.BackingStoreException; public class FontSelection { - + public static final String VAR_FONT_STYLE = "fontStyle"; //$NON-NLS-1$ public static final String FONT_ABSOLUTE = "absolute"; //$NON-NLS-1$ - public static final String FONT_RELATIVE = "relative"; //$NON-NLS-1$ + public static final String FONT_RELATIVE = "relative"; //$NON-NLS-1$ private static final String SCALE_FACTOR = "scaleFactor"; //$NON-NLS-1$ public static final String ATT_SCALABLE = "scalable"; //$NON-NLS-1$ - - private static final int MIN_HEIGHT = 10; + + private static final int MIN_HEIGHT = 10; private static final int MAX_HEIGHT = 16; - + /* * Returns the height in points of the default SWT font */ private static int getDefaultFontHeight() { Font defaultFont = JFaceResources.getDefaultFont(); FontData[] fontData = defaultFont.getFontData(); - int height = MIN_HEIGHT; + int height = MIN_HEIGHT; for (int i=0; i< fontData.length; i++) { FontData data = fontData[i]; height = Math.max(height, data.getHeight()); @@ -58,7 +58,7 @@ public class FontSelection { result += getFontSizeDeclaration("h6", defaultFontHeight, 70, scale); //$NON-NLS-1$ return result; } - + public static final int getScalePercentage() { int scale = Platform.getPreferencesService().getInt(IntroPlugin.PLUGIN_ID, (SCALE_FACTOR), 0, null); return scale; @@ -72,13 +72,13 @@ public class FontSelection { public static void setScalePercentage(int i) { IEclipsePreferences prefs = InstanceScope.INSTANCE.getNode(IntroPlugin.PLUGIN_ID); - prefs.putInt(SCALE_FACTOR, i); + prefs.putInt(SCALE_FACTOR, i); try { prefs.flush(); } catch (BackingStoreException e) { - } + } } - + // Set the scale factor to it's default public static void resetScalePercentage() { IEclipsePreferences iprefs = InstanceScope.INSTANCE.getNode(IntroPlugin.PLUGIN_ID); @@ -97,7 +97,7 @@ public class FontSelection { return style; } style = Platform.getPreferencesService().getString - (IntroPlugin.PLUGIN_ID, (FontSelection.VAR_FONT_STYLE), "", null); //$NON-NLS-1$ + (IntroPlugin.PLUGIN_ID, (FontSelection.VAR_FONT_STYLE), "", null); //$NON-NLS-1$ if (style.length() > 0) { return style; } diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/IntroPlugin.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/IntroPlugin.java index e4970bcf4..df39994bc 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/IntroPlugin.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/IntroPlugin.java @@ -30,11 +30,11 @@ public class IntroPlugin extends AbstractUIPlugin { public static final String PLUGIN_ID = "org.eclipse.ui.intro"; //$NON-NLS-1$ // Debug control variables - public static boolean LOG_WARN = + public static boolean LOG_WARN = "true".equalsIgnoreCase(Platform.getDebugOption(PLUGIN_ID+"/debug/warn")); //$NON-NLS-1$ //$NON-NLS-2$ - public static boolean LOG_INFO = + public static boolean LOG_INFO = "true".equalsIgnoreCase(Platform.getDebugOption(PLUGIN_ID+"/debug/info")); //$NON-NLS-1$ //$NON-NLS-2$ - + // The static shared instance. private static IntroPlugin inst; @@ -45,12 +45,12 @@ public class IntroPlugin extends AbstractUIPlugin { // used for performance logging. Time when the constructor of // CustomizableIntroPart is called. private long uiCreationStartTime; - + // image registry that can be disposed while the // plug-in is still active. This is important for // switching themes after the plug-in has been loaded. private ImageRegistry volatileImageRegistry; - + // debug options public static boolean DEBUG = false; public static boolean DEBUG_NO_BROWSER = false; @@ -69,7 +69,7 @@ public class IntroPlugin extends AbstractUIPlugin { public static IntroPlugin getDefault() { return inst; } - + public ImageRegistry getVolatileImageRegistry() { if (volatileImageRegistry==null) { volatileImageRegistry = createImageRegistry(); @@ -77,7 +77,7 @@ public class IntroPlugin extends AbstractUIPlugin { } return volatileImageRegistry; } - + public void resetVolatileImageRegistry() { if (volatileImageRegistry!=null) { volatileImageRegistry.dispose(); @@ -108,7 +108,7 @@ public class IntroPlugin extends AbstractUIPlugin { /** * Returns the model root. Will always guarantee that model is loaded. - * + * * @return Returns the introModelRoot. */ public IntroModelRoot getIntroModelRoot() { @@ -201,8 +201,8 @@ public class IntroPlugin extends AbstractUIPlugin { */ public static synchronized void logError(String message) { logError(message,null); - } - + } + /** * Logs an Error message with an exception. To print errors to console, * run eclipse with the -console -consolelog arguments @@ -213,13 +213,13 @@ public class IntroPlugin extends AbstractUIPlugin { } Status errorStatus = new Status(IStatus.ERROR, PLUGIN_ID, message, ex); IntroPlugin.getDefault().getLog().log(errorStatus); - } - - + } + + /** * Logs a Warning message with an exception. To print warnings to console, * run eclipse with the -console -consolelog arguments - * + * * Only logs if the following conditions are true: * -debug switch is enabled at the command line * .options file is placed at the eclipse work directory with the contents: @@ -229,7 +229,7 @@ public class IntroPlugin extends AbstractUIPlugin { public static synchronized void logWarning(String message) { logWarning(message,null); } - + public static synchronized void logWarning(String message,Throwable ex) { if (IntroPlugin.getDefault().isDebugging() && LOG_WARN) { @@ -240,11 +240,11 @@ public class IntroPlugin extends AbstractUIPlugin { getDefault().getLog().log(warningStatus); } } - + /** * Logs a debug message. To print messages to console, * run eclipse with the -console -consolelog arguments - * + * * Only logs if the following conditions are true: * -debug switch is enabled at the command line * .options file is placed at the eclipse work directory with the contents: diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/Messages.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/Messages.java index 3b07660d5..50005e144 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/Messages.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/Messages.java @@ -55,7 +55,7 @@ public class Messages extends NLS { // ------- public static String IntroPart_openExternal_tooltip; public static String IntroPart_showContentButton_tooltip; - + //Always Welcome Checkbox public static String AlwaysWelcomeCheckbox_Text; diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/html/FormattedHTMLElement.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/html/FormattedHTMLElement.java index 316d78969..065e09586 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/html/FormattedHTMLElement.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/html/FormattedHTMLElement.java @@ -54,7 +54,7 @@ public class FormattedHTMLElement extends HTMLElement { } /** * Set whether the end tag is required for this element - * + * * @param required * true if end tag required, false otherwise */ @@ -63,7 +63,7 @@ public class FormattedHTMLElement extends HTMLElement { } /** * Set the indent level that should be applied to this element when printed - * + * * @param indentLevel * The indentLevel to set. */ @@ -73,7 +73,7 @@ public class FormattedHTMLElement extends HTMLElement { /** * Set whether or not this element should be printed over multiple lines, * or on a single line - * + * * @param spanMultipleLines * true if the element should be printed over multiple lines, * false if it should be printed on a single line @@ -83,7 +83,7 @@ public class FormattedHTMLElement extends HTMLElement { } /** * Create a string of tabs to insert before the element is printed - * + * * @param indentLevel * the number of tabs to insert * @return diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/html/HTMLElement.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/html/HTMLElement.java index aac3a49df..d2babce9e 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/html/HTMLElement.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/html/HTMLElement.java @@ -45,7 +45,7 @@ public class HTMLElement { /** * Add an attribute with the given name and value to this HTMLElement - * + * * @param attributeName * @param attributeValue */ @@ -64,7 +64,7 @@ public class HTMLElement { /** * Get the attributes associated with this element - * + * * @return Returns the elementAttributes. */ public Map<String, String> getElementAttributes() { @@ -76,7 +76,7 @@ public class HTMLElement { /** * Set the attributes associated with this element - * + * * @param elementAttributes * The elementAttributes to set. */ @@ -86,7 +86,7 @@ public class HTMLElement { /** * Get this element's content - * + * * @return Returns the elementContent. */ public Vector<Object> getElementContent() { @@ -98,7 +98,7 @@ public class HTMLElement { /** * Set this element's content - * + * * @param elementContent * The elementContent to set. */ @@ -108,7 +108,7 @@ public class HTMLElement { /** * Get the name of this element - * + * * @return Returns the elementName. */ public String getElementName() { @@ -117,7 +117,7 @@ public class HTMLElement { /** * Set the name of this element - * + * * @param elementName * The elementName to set. */ diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/html/HTMLUtil.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/html/HTMLUtil.java index 699a61905..37b495f28 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/html/HTMLUtil.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/html/HTMLUtil.java @@ -21,7 +21,7 @@ public final class HTMLUtil { /** * Creates an HTML opening element of the form <elementName * elementAttributes> - * + * * @param elementName * the name of the element to create * @param elementAttributes @@ -50,7 +50,7 @@ public final class HTMLUtil { /** * Creates an HTML start tag of the form <elementName> - * + * * @param elementName * the name of the element to create * @param insertLineBreak @@ -65,7 +65,7 @@ public final class HTMLUtil { /** * Creates an HTML start tag of the form <elementName>and inserts a line * break after the start tag - * + * * @param elementName * the name of the element to create * @return @@ -76,7 +76,7 @@ public final class HTMLUtil { /** * Creates an HTML closing element of the form </elementName> - * + * * @param elementName * the name of the closing element to create * @param addNewLine @@ -97,7 +97,7 @@ public final class HTMLUtil { * Given a map of attribute names and values, this method will create a * StringBuffer of the attributes in the form: attrName="attrValue". These * attributes can appear in the start tag of an HTML element. - * + * * @param attributes * the attributes to be converted into a String list * @return @@ -123,7 +123,7 @@ public final class HTMLUtil { /** * Creates an HTML attribute of the form attrName="attrValue" - * + * * @param attrName * the name of the attribute * @param attrValue @@ -159,7 +159,7 @@ public final class HTMLUtil { /** * Determine if the contents of two character arrays are equal - * + * * @param a * @param b * @return diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/html/IntroHTMLGenerator.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/html/IntroHTMLGenerator.java index e9b53ee1b..c5489cd35 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/html/IntroHTMLGenerator.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/html/IntroHTMLGenerator.java @@ -57,7 +57,7 @@ public class IntroHTMLGenerator { /** * Generates the HTML code that will be presented in the browser widget for the provided intro * page. - * + * * @param page * the page to generate HTML for * @param presentation @@ -70,13 +70,13 @@ public class IntroHTMLGenerator { this.providerSite = providerSite; initializeBackgroundSizeWorks(); - + // generate and add the appropriate encoding to the top of the document // generateEncoding(); // create the main HTML element, and all of its contents. return generateHTMLElement(); } - + private void initializeBackgroundSizeWorks() { // Internet Explorer <= 9 doesn't properly handle background-size backgroundSizeWorks = true; @@ -100,7 +100,7 @@ public class IntroHTMLGenerator { /** * Return the SWT Browser instance being used to render the intro. - * + * * @return the browser or {@code null} if the browser could not be determined */ private Browser getBrowser() { @@ -119,9 +119,9 @@ public class IntroHTMLGenerator { /** * Generates the HTML element and its content: - * + * * <pre> - * + * * <HTML> * <HEAD> * head content @@ -130,9 +130,9 @@ public class IntroHTMLGenerator { * body content * </BODY> * </HTML> - * + * * </pre> - * + * * @return the html HTMLElement */ private HTMLElement generateHTMLElement() { @@ -148,10 +148,10 @@ public class IntroHTMLGenerator { /** * Generates the HEAD element and its content: - * + * * <pre> - * - * + * + * * <HEAD> * <BASE href="base_plugin_location> * <style type="text/css">HTML, IMG { border: 0px; } </style> @@ -159,9 +159,9 @@ public class IntroHTMLGenerator { * <LINK href="style sheet"> * additional head content, if specified * </HEAD> - * + * * </pre> - * + * * @param indentLevel * the number of indents to insert before the element when it is printed * @return the head HTMLElement @@ -228,7 +228,7 @@ public class IntroHTMLGenerator { /** * Add any browser-specific rendering quirks - * + * * @param indentLevel */ private void addBrowserRenderingDirectives(HTMLElement head, int indentLevel) { @@ -272,18 +272,18 @@ public class IntroHTMLGenerator { /** * Generates the BODY element and its content: - * + * * <pre> - * - * + * + * * <BODY> * <DIV id="pageId" class="pageClass"> * page content * </DIV> * </BODY> - * + * * </pre> - * + * * @param indentLevel * the number of indents to insert before the element when it is printed * @return the body HTMLElement @@ -317,7 +317,7 @@ public class IntroHTMLGenerator { /** * Given an IntroElement, generate the appropriate HTMLElement - * + * * @param element * the IntroElement * @param indentLevel @@ -343,7 +343,7 @@ public class IntroHTMLGenerator { case AbstractIntroElement.IMAGE: return generateIntroImage((IntroImage) element, indentLevel); case AbstractIntroElement.HR: - return generateIntroSeparator((IntroSeparator) element, indentLevel); + return generateIntroSeparator((IntroSeparator) element, indentLevel); case AbstractIntroElement.TEXT: return generateIntroText((IntroText) element, indentLevel); case AbstractIntroElement.PAGE_TITLE: @@ -357,17 +357,17 @@ public class IntroHTMLGenerator { /** * Create a div element and its content from an IntroDiv: - * + * * <pre> - * - * + * + * * <div id="attrvalue"> * <h4><span class="div-label">attrvalue</span><h4> * any defined divs, links, html, images, text, includes * </div> - * + * * </pre> - * + * * @param element * the IntroDiv * @param indentLevel @@ -400,11 +400,11 @@ public class IntroHTMLGenerator { StringBuffer call = new StringBuffer(); call.append("return (toggleSection('");//$NON-NLS-1$ call.append(clientId); - call.append("','");//$NON-NLS-1$ + call.append("','");//$NON-NLS-1$ call.append(toggleClosedId); - call.append("','");//$NON-NLS-1$ + call.append("','");//$NON-NLS-1$ call.append(toggleOpenId); - call.append("'))"); //$NON-NLS-1$ + call.append("'))"); //$NON-NLS-1$ link.addAttribute("onClick", call.toString()); //$NON-NLS-1$ link.addContent(divLabel); divElement.addContent(link); @@ -427,7 +427,7 @@ public class IntroHTMLGenerator { IIntroConstants.PLUGIN_ID)); toggleImageOpen.addAttribute(IIntroHTMLConstants.ATTRIBUTE_CLASS, "section-toggle-image-open"); //$NON-NLS-1$ if (element.isExpanded()) - toggleImageOpen.addAttribute(IIntroHTMLConstants.ATTRIBUTE_STYLE, "display: inline"); //$NON-NLS-1$ + toggleImageOpen.addAttribute(IIntroHTMLConstants.ATTRIBUTE_STYLE, "display: inline"); //$NON-NLS-1$ link.addContent(toggleImageOpen); childContainer = generateDivElement(clientId, indentLevel + 1); childContainer.addAttribute("class", "section-body"); //$NON-NLS-1$//$NON-NLS-2$ @@ -481,17 +481,17 @@ public class IntroHTMLGenerator { /** * Generates an anchor (link) element and its content from an IntroLink: - * + * * <pre> - * + * * <A id=linkId class="link" href=linkHref> * <IMG src="blank.gif"> * <SPAN class="link-label">linkLabel </SPAN> * <P><SPAN>text</SPAN></P> * </A> - * + * * </pre> - * + * * @param element * the IntroLink * @param indentLevel @@ -525,7 +525,7 @@ public class IntroHTMLGenerator { } if (!useTable) { HTMLElement imageDiv = new FormattedHTMLElement(IIntroHTMLConstants.ELEMENT_DIV, indentBase+1, false); - imageDiv.addAttribute(IIntroHTMLConstants.ATTRIBUTE_CLASS, + imageDiv.addAttribute(IIntroHTMLConstants.ATTRIBUTE_CLASS, IIntroHTMLConstants.LINK_EXTRA_DIV); anchor1.addContent(imageDiv); } @@ -533,7 +533,7 @@ public class IntroHTMLGenerator { if (element.getLabel() != null) { HTMLElement label = generateSpanElement(IIntroHTMLConstants.SPAN_CLASS_LINK_LABEL, indentBase + 2); - label.addContent(element.getLabel()); + label.addContent(element.getLabel()); labelAnchor.addContent(label); } IntroText linkText = element.getIntroText(); @@ -562,7 +562,7 @@ public class IntroHTMLGenerator { * content from the referenced file is emitted as-is into a div element. If the type is "embed", * an OBJECT html element is created whose <code>data</code> attribute is equal to the * IntroHTML's <code>src</code> value - * + * * @param element * the IntroHTML * @param indentLevel @@ -578,13 +578,13 @@ public class IntroHTMLGenerator { /** * Generate an image element from an IntroImage: - * + * * <pre> - * + * * <IMG src=imageSrc id=imageId> - * + * * </pre> - * + * * @param element * the IntroImage * @param indentLevel @@ -598,7 +598,7 @@ public class IntroHTMLGenerator { imageElement.addAttribute(IIntroHTMLConstants.ATTRIBUTE_ID, element.getId()); return imageElement; } - + private HTMLElement generateIntroSeparator(IntroSeparator element, int indentLevel) { HTMLElement hrElement = new FormattedHTMLElement(IIntroHTMLConstants.ELEMENT_HR, indentLevel, false); if (element.getId() != null) @@ -612,14 +612,14 @@ public class IntroHTMLGenerator { * Generate a paragraph (<P>) element from an IntroText. The paragraph element will * contain a span element that will contain the actual text. Providing the span element provides * additional flexibility for CSS designers. - * + * * <pre> - * - * + * + * * <P><SPAN>spanContent</SPAN></P> - * + * * </pre> - * + * * @param element * the IntroText * @param indentLevel @@ -659,16 +659,16 @@ public class IntroHTMLGenerator { /** * Generate "inline" content from an IntroHTML. The content from the file referenced by the * IntroHTML's <code>src</code> attribute is emitted as-is into a div element: - * + * * <pre> - * - * + * + * * <div id="attrvalue" class="attrvalue2"> * content from file specified in src attribute * </div> - * + * * </pre> - * + * * @param element * the IntroHTML * @param indentLevel @@ -694,7 +694,7 @@ public class IntroHTMLGenerator { /** * Includes HTML content that is created by an IIntroContentProvider implementation. - * + * * @param element * @param indentLevel * @return @@ -739,15 +739,15 @@ public class IntroHTMLGenerator { /** * Generate "embedded" content from an IntroHTML. An OBJECT html element is created whose * <code>data</code> attribute is equal to the IntroHTML's <code>src</code> value. - * + * * <pre> - * + * * <OBJECT type="text/html" data="attrvalue"> * alternative text in case the object can not be rendered - * </OBJECT> - * + * </OBJECT> + * * </pre> - * + * * @param element * the IntroHTML * @param indentLevel @@ -786,13 +786,13 @@ public class IntroHTMLGenerator { /** * Generates the BASE element for the head of the html document. Each document can have only one * base element - * + * * <pre> - * - * + * + * * <BASE href=baseURL> * </pre> - * + * * @param indentLevel * @param baseURL * @return @@ -807,13 +807,13 @@ public class IntroHTMLGenerator { /** * Generates the style element that goes into HEAD: - * + * * <pre> - * + * * <style type="text/css">HTML, IMG { border: 0px; } </style> - * + * * </pre> - * + * * @param indentLevel * the number of indents to insert before the element when it is printed * @return the style HTMLElement @@ -823,9 +823,9 @@ public class IntroHTMLGenerator { style.addAttribute(IIntroHTMLConstants.ATTRIBUTE_TYPE, IIntroHTMLConstants.LINK_STYLE); style.addContent(IIntroHTMLConstants.STYLE_HTML); IntroTheme theme = introPage.getModelRoot().getTheme(); - if (theme != null && theme.isScalable() + if (theme != null && theme.isScalable() && FontSelection.FONT_RELATIVE.equals(FontSelection.getFontStyle())) { - String sizeStyle = FontSelection.generatePageFontStyle(); + String sizeStyle = FontSelection.generatePageFontStyle(); style.addContent(sizeStyle); } return style; @@ -833,13 +833,13 @@ public class IntroHTMLGenerator { /** * Generates the title element and its content: - * + * * <pre> - * + * * <TITLE>intro title</TITLE> - * + * * </pre> - * + * * @param title * the title of this intro page * @param indentLevel @@ -856,13 +856,13 @@ public class IntroHTMLGenerator { /** * Generates a link element that refers to a cascading style sheet (CSS): - * + * * <pre> - * - * + * + * * <LINK rel="stylesheet" style="text/css" href="style sheet"> * </pre> - * + * * @param href * the value of the href attribute for this link element * @param indentLevel @@ -881,13 +881,13 @@ public class IntroHTMLGenerator { /** * Generate an anchor element: - * + * * <pre> - * + * * <A id=linkId class=linkClass href=linkHref> </A> - * + * * </pre> - * + * * @param link * the IntroLink element that contains the value for the id and href attributes * @param indentLevel @@ -909,16 +909,16 @@ public class IntroHTMLGenerator { /** * Generates a div block that contains a header and span element: - * + * * <pre> - * - * + * + * * <DIV id=divId> * <H><SPAN>spanContent </SPAN> </H> * </DIV> - * + * * </pre> - * + * * @param divId * the id of the div to create * @param divClass @@ -945,13 +945,13 @@ public class IntroHTMLGenerator { * Generates a span element inside a text element, where the text element can be a P * (paragraph), or any of the H (Header) elements. Providing the span element provides * additional flexibility for CSS designers. - * + * * <pre> - * + * * <P><SPAN>spanContent</SPAN></P> - * + * * </pre> - * + * * @param type * the type of text element to create (e.g., P, H1, H2, etc) * @param spanID @@ -986,7 +986,7 @@ public class IntroHTMLGenerator { /** * Generates a DIV element with the provided indent, id, and class. - * + * * @param divId * value for the div's id attribute * @param divClass @@ -1003,7 +1003,7 @@ public class IntroHTMLGenerator { /** * Generates a DIV element with the provided indent and id. - * + * * @param divId * value for the div's id attribute * @param indentLevel @@ -1019,14 +1019,14 @@ public class IntroHTMLGenerator { /** * Generates an IMG element: - * + * * <pre> - * - * + * + * * <IMG src=imageSrc alt=altText> - * + * * </pre> - * + * * @param imageSrc * the value to be supplied to the src attribute * @param indentLevel @@ -1068,14 +1068,14 @@ public class IntroHTMLGenerator { /** * Generate a span element - * + * * <pre> - * + * * <SPAN class=spanClass> </SPAN> - * - * + * + * * </pre> - * + * * @param spanClass * the value to be supplied to the class attribute * @param indentLevel @@ -1090,12 +1090,12 @@ public class IntroHTMLGenerator { /** * Generate a span element - * + * * <pre> - * + * * <iframe src="localPage1.xhtml" frameborder="1" scrolling="auto" longdesc="localPage1.xhtml"> * </pre> - * + * * @param spanClass * the value to be supplied to the class attribute * @param indentLevel @@ -1129,7 +1129,7 @@ public class IntroHTMLGenerator { * content in the form of a StringBuffer. If the file read contains substitution segments of the * form $plugin:plugin_id$ then this method will make the proper substitution (the segment will * be replaced with the absolute path to the plugin with id plugin_id). - * + * * @param src - * the file that contains the target conent * @param charsetName - @@ -1198,7 +1198,7 @@ public class IntroHTMLGenerator { * substitution string is of the form: <code>$plugin:plugin_id$</code> where plugin_id is the * valid id of an installed plugin. The substitution string will be replaced with the absolute * path to the plugin. - * + * * An example usage of the string substution: The html file <code>inline.html</code> is * included in your intro via the html inline mechanism . This file needs to reference a * resource that is located in another plugin. The following might be found in inline.html: @@ -1208,7 +1208,7 @@ public class IntroHTMLGenerator { * is read in, the relevant section will be replaced as follows: <code> * <a href="file:/install_path/plugins/test.plugin/html/test.html">link to file</a> * </code> - * + * */ private static class PluginIdParser { @@ -1244,7 +1244,7 @@ public class IntroHTMLGenerator { * above conditions are not met, no substitution occurs. If the above conditions are met, * the content between (and including) the opening and closing "$" characters will be * replaced by the absolute path to the plugin - * + * * @return */ protected String parsePluginId() { @@ -1288,10 +1288,10 @@ public class IntroHTMLGenerator { * expected characters are found, they will be appended to the tokenContent StringBuffer and * the method will return true. If they are not found, false is returned and the caller * should reset the BufferedReader to the position it was in before this method was called. - * + * * Resetting the reader ensures that the characters read in this method can be re-examined * in case one of them happens to be the beginning of a valid substitution segment. - * + * * @return true if the next characters match <code>plugin:</code>, and false otherwise. */ private boolean findValidPluginSegment() { @@ -1320,10 +1320,10 @@ public class IntroHTMLGenerator { * SUBSTITUTION_END character is found, the method looks up the plugin id that has been * built up to see if it is a valid id. If so, return the absolute path to that plugin. If * not, return null. - * + * * This method assumes that the reader is positioned just after a valid <code>plugin:</code> * segment in a substitution string. - * + * * @return absolute path of the plugin id, if valid. null otherwise */ private String getPluginPath() { diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractBaseIntroElement.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractBaseIntroElement.java index b04b284af..53691f916 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractBaseIntroElement.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractBaseIntroElement.java @@ -51,7 +51,7 @@ public abstract class AbstractBaseIntroElement extends AbstractIntroIdElement { /** * Filter this element out based on the presentation kind. - * + * */ private boolean checkFilterState() { if (this.isOfType(AbstractIntroElement.MODEL_ROOT)) @@ -69,7 +69,7 @@ public abstract class AbstractBaseIntroElement extends AbstractIntroIdElement { public String getStyleId() { return style_id; } - + @Override protected void loadFromParent() { style_id = getAttribute(getElement(), ATT_STYLE_ID); @@ -88,7 +88,7 @@ public abstract class AbstractBaseIntroElement extends AbstractIntroIdElement { * this element has been added to the model, and it has a parent. Also, this * method will not be valid if the UI has not been loaded yet because it it * the creation of the UI that determines the presentation details. - * + * * @return Returns the isFiltered. */ public boolean isFiltered() { diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroContainer.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroContainer.java index 0b1765dd6..7924e8ca0 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroContainer.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroContainer.java @@ -70,7 +70,7 @@ public abstract class AbstractIntroContainer extends AbstractBaseIntroElement { /** * Get the children of this container. Loading children and resolving * includes and extension is delayed until this method call. - * + * * @return Returns all the children of this container. */ public AbstractIntroElement[] getChildren() { @@ -86,7 +86,7 @@ public abstract class AbstractIntroContainer extends AbstractBaseIntroElement { resolveChildren(); Vector filtered = filterChildren(children); - + AbstractIntroElement[] childrenElements = (AbstractIntroElement[]) convertToModelArray( filtered, AbstractIntroElement.ELEMENT); return childrenElements; @@ -99,7 +99,7 @@ public abstract class AbstractIntroContainer extends AbstractBaseIntroElement { * <p> * <code> * int elementMask = IntroElement.IMAGE | IntroElement.DEFAULT_LINK; - * int elementMask = IntroElement.ABSTRACT_CONTAINER; + * int elementMask = IntroElement.ABSTRACT_CONTAINER; * </code> * The return type is determined depending on the mask. If the mask is a * predefined constant in the IntroElement, and it does not correspond to an @@ -111,7 +111,7 @@ public abstract class AbstractIntroContainer extends AbstractBaseIntroElement { * <code> * Introgroup[] groups = (IntroGroup[])page.getChildrenOfType(IntroElement.GROUP); * </code> - * + * * However, if the element mask is not homogenous (for example: LINKS | * GROUP) then the returned array must be cast to an array of * IntroElements.For exmaple, the following code gets all images and links @@ -120,10 +120,10 @@ public abstract class AbstractIntroContainer extends AbstractBaseIntroElement { * <p> * <code> * int elementMask = IntroElement.IMAGE | IntroElement.DEFAULT_LINK; - * IntroElement[] imagesAndLinks = + * IntroElement[] imagesAndLinks = * (IntroElement[])page.getChildrenOfType(elementMask); * </code> - * + * * @return An array of elements of the right type. If the container has no * children, or no children of the specified types, returns an empty * array. @@ -149,7 +149,7 @@ public abstract class AbstractIntroContainer extends AbstractBaseIntroElement { * IntroElement instances. If elementMask is a predefined model type (ie: * homogenous), then return array of corresponding type. Else, returns an * array of IntroElements. - * + * * @param vector */ private Object[] convertToModelArray(Vector vector, int elementMask) { @@ -205,7 +205,7 @@ public abstract class AbstractIntroContainer extends AbstractBaseIntroElement { src = new AbstractIntroElement[size]; break; } - + vector.copyInto(src); return src; @@ -219,7 +219,7 @@ public abstract class AbstractIntroContainer extends AbstractBaseIntroElement { protected void loadChildren() { // init the children vector. old children are disposed automatically. children = new Vector<>(); - + NodeList nodeList = element.getChildNodes(); Vector<Node> vector = new Vector<>(); @@ -241,7 +241,7 @@ public abstract class AbstractIntroContainer extends AbstractBaseIntroElement { /** * Adds the given elements as children of this container, before the * specified index. - * + * * @param childElements */ protected void insertElementsBefore(Element[] childElements, Bundle bundle, @@ -263,7 +263,7 @@ public abstract class AbstractIntroContainer extends AbstractBaseIntroElement { /** * Adds the given elements as children of this container, before the * specified element. The element must be a direct child of this container. - * + * * @param childElements */ protected void insertElementsBefore(Element[] childElements, Bundle bundle, @@ -280,7 +280,7 @@ public abstract class AbstractIntroContainer extends AbstractBaseIntroElement { /** * Adds a child to this container, depending on its type. Subclasses may * override if there is a child specific to the subclass. - * + * * @param childElements */ protected AbstractIntroElement getModelChild(Element childElement, @@ -340,7 +340,7 @@ public abstract class AbstractIntroContainer extends AbstractBaseIntroElement { * and adds it as a child of this current container. If target is not a * group, or any element that can be included in a group, ignore this * include. - * + * * @param include */ private void resolveInclude(IntroInclude include) { @@ -361,7 +361,7 @@ public abstract class AbstractIntroContainer extends AbstractBaseIntroElement { * Filters the appropriate elements from the given Vector, according to the current * environment. For example, if one of the elements has a tag to filter for os=linux and * the os is win32, the element will not be returned in the resulting Vector. - * + * * @param unfiltered the unfiltered elements * @return a new Vector with elements filtered */ @@ -376,12 +376,12 @@ public abstract class AbstractIntroContainer extends AbstractBaseIntroElement { } return filtered; } - + /** * Find the target element pointed to by the path in the include. It is * assumed that configId always points to an external config, and not the * same config of the inlcude. - * + * * @param include * @param path * @return @@ -406,7 +406,7 @@ public abstract class AbstractIntroContainer extends AbstractBaseIntroElement { * model.<br> * ps: This method could be a static method, but left as instance for model * enhancements. - * + * * @param model * @param path * @return @@ -417,7 +417,7 @@ public abstract class AbstractIntroContainer extends AbstractBaseIntroElement { String[] pathSegments = StringUtil.split(path, "/"); //$NON-NLS-1$ if (container == null) return null; - + AbstractIntroElement target = container.findChild(pathSegments[0]); if (target == null) // there is no direct child with the specified first path segment. @@ -437,7 +437,7 @@ public abstract class AbstractIntroContainer extends AbstractBaseIntroElement { } return target; } - + public AbstractIntroElement findTarget(AbstractIntroContainer container, String path, String extensionId) { // resolve path segments if they are incomplete. @@ -465,7 +465,7 @@ public abstract class AbstractIntroContainer extends AbstractBaseIntroElement { * searches direct children for the first child with the given id. The type * of the child can be any model element that has an id. ie: * AbstractIntroIdElement - * + * * @see org.eclipse.ui.internal.intro.impl.model.IntroElement#getType() */ public AbstractIntroElement findChild(String elementId) { @@ -477,7 +477,7 @@ public abstract class AbstractIntroContainer extends AbstractBaseIntroElement { * of the child must be of the passed model types mask. This method handles * the 3.0 style model for content. Pages enhance this behavior with DOM * apis. - * + * * @see org.eclipse.ui.internal.intro.impl.model.IntroElement#getType() */ public AbstractIntroElement findChild(String elementId, int elementMask) { @@ -537,7 +537,7 @@ public abstract class AbstractIntroContainer extends AbstractBaseIntroElement { * plugin. Also note that when including a container, it must be resolved * otherwise reparenting will cause includes in this target container to * fail. - * + * * @param include * @param target */ @@ -579,11 +579,11 @@ public abstract class AbstractIntroContainer extends AbstractBaseIntroElement { /** * Creates a clone of the given target node. A clone is create by simply * recreating that protion of the model. - * + * * Note: looked into the clonable interface in Java, but it was not used * because it makes modifications/additions to the model harder to maintain. * Will revisit later. - * + * * @param targer * @return */ @@ -617,7 +617,7 @@ public abstract class AbstractIntroContainer extends AbstractBaseIntroElement { /** * Returns the element. - * + * * @return */ @Override @@ -642,13 +642,13 @@ public abstract class AbstractIntroContainer extends AbstractBaseIntroElement { /** * Adds a model element as a child. Caller is responsible for inserting * model elements that rea valid as children. - * + * * @param child */ public void addChild(AbstractIntroElement child) { children.add(child); } - + public void removeChild(AbstractIntroElement child) { children.remove(child); } diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroElement.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroElement.java index 2e1eaba2f..13adf8cf7 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroElement.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroElement.java @@ -139,12 +139,12 @@ public abstract class AbstractIntroElement implements Cloneable { * Type constant which identifies am injected IFrame model element. */ public static final int INJECTED_IFRAME = 1 << 17; - + /** * Type constant for the theme element. */ public static final int THEME = 1 << 18; - + /** * Type constant for the hr element. */ @@ -196,7 +196,7 @@ public abstract class AbstractIntroElement implements Cloneable { * Constructor used when model elements are being loaded from an xml content * file. Bundle is propagated down the model to enable resolving resources * relative to the base of the bundle. - * + * * @param element * @param pd */ @@ -214,7 +214,7 @@ public abstract class AbstractIntroElement implements Cloneable { * In the case of a configExtension, it is set to point to the relative * position of the parent folder that holds the extension. Only when needed, * the base field is stored in a model element. This saves memory. - * + * * @param element * @param pd */ @@ -229,13 +229,13 @@ public abstract class AbstractIntroElement implements Cloneable { * Returns the configuration element from which this intro element was * loaded. In the case of extension, returns the configuration element of * the defining extension. - * + * * @return */ public IConfigurationElement getCfgElement() { return cfgElement instanceof IConfigurationElement?(IConfigurationElement)cfgElement:null; } - + public Element getElement() { return cfgElement instanceof Element?(Element)cfgElement:null; } @@ -244,7 +244,7 @@ public abstract class AbstractIntroElement implements Cloneable { * DOM getAttribute retruns an empty string (not null) if attribute is not * defined. Override this behavior to be consistent with Intro Model, and * IConfiguration element. - * + * * @param element * @param att * @return @@ -264,7 +264,7 @@ public abstract class AbstractIntroElement implements Cloneable { /** * Util method to parse a comma separated list of values - * + * * @param element * @param att * @return @@ -278,7 +278,7 @@ public abstract class AbstractIntroElement implements Cloneable { if (root!=null) { for (int i = 0; i < splitValues.length; i++) { splitValues[i] = root.resolveVariables(splitValues[i]); - } + } } return splitValues; } @@ -289,7 +289,7 @@ public abstract class AbstractIntroElement implements Cloneable { */ return null; } - + protected void loadFromParent() { } @@ -298,7 +298,7 @@ public abstract class AbstractIntroElement implements Cloneable { * Returns the plugin descriptor of the plugin from which this intro element * was loaded. In the case of extension, returns the plugin descriptor of * the plugin defining the extension. - * + * * @return */ public Bundle getBundle() { @@ -310,7 +310,7 @@ public abstract class AbstractIntroElement implements Cloneable { /** * Returns the specific model type of this intro element. To be implemented * by all subclasses. - * + * * @return returns one of the model class types defined in this class. */ public abstract int getType(); @@ -331,7 +331,7 @@ public abstract class AbstractIntroElement implements Cloneable { * <li>for Head elements that are children of Implementation elements * (shared Heads), it returns the holding presentation element.</li> * </ul> - * + * * @return returns the parent of this intro element. Null only for model * root. */ @@ -382,7 +382,7 @@ public abstract class AbstractIntroElement implements Cloneable { return (AbstractIntroPage) parent; return null; } - + public IntroModelRoot getModelRoot() { // return yourself if you are a model root. if (isOfType(AbstractIntroElement.MODEL_ROOT)) @@ -397,7 +397,7 @@ public abstract class AbstractIntroElement implements Cloneable { parent = parent.getParent(); if (parent.isOfType(MODEL_ROOT)) return (IntroModelRoot) parent; - return null; + return null; } @@ -409,7 +409,7 @@ public abstract class AbstractIntroElement implements Cloneable { * int elementMask = IntroElement.ABSTRACT_CONTAINER; * int elementMask = IntroElement.DIV | IntroElement.DEFAULT_LINK; * </code> - * + * * @param elementMask * element mask formed by bitwise OR of element type constants * defined in this class. @@ -428,7 +428,7 @@ public abstract class AbstractIntroElement implements Cloneable { * <code> * int elementMask = IntroElement.DIV | IntroElement.DEFAULT_LINK; * </code> - * + * * @return <code>true</code> if all elements are of the right type, and * <code>false</code> if the list is empty, or at least one * element is not of the specified types. @@ -459,13 +459,13 @@ public abstract class AbstractIntroElement implements Cloneable { } - + public String getMixinStyle() { return mixinStyle; } - + public void setMixinStyle(String mixinStyle) { this.mixinStyle = mixinStyle; } diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroIdElement.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroIdElement.java index ecb5388f8..2f499d2a2 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroIdElement.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroIdElement.java @@ -19,7 +19,7 @@ import org.w3c.dom.Element; * An Intro Config component that has an id attribute. It is used as a base * class for all config elements that can take an id, and hence are valid * targets for includes and finds. - * + * */ public abstract class AbstractIntroIdElement extends AbstractIntroElement { diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroPage.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroPage.java index dc3f9fb8e..8527efbd9 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroPage.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroPage.java @@ -80,7 +80,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { // DOM representing XHTML content. DOM is only cached in the case of XHTML // content. private Document dom; - + private DocumentProcessor domProcessor; // set when the content file is loaded (ie: loadChildren is called) @@ -125,7 +125,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { * different from the bundle for all the other pages. Only pages do this * logic and so other model objects might have the wrong bundle cached if * the resource was loaded from an nl directory. - * + * * @param element */ AbstractIntroPage(Element element, Bundle bundle, String base) { @@ -167,20 +167,20 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { url = ModelUtil.resolveURL(base, url, bundle); } - + @Override public void setParent(AbstractIntroElement parent) { super.setParent(parent); if (content == null) init(element, getBundle(), initialBase); } - + /** * Returns unresolved content value as found in the source file. * the source file. * @return the unresolved content value */ - + public String getRawContent() { return getAttribute(element, ATT_CONTENT); } @@ -189,7 +189,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { * Initialize styles. Take first style in style attribute and make it the * page style. Then put other styles in styles vectors. Make sure to resolve * each style. - * + * * @param element * @param bundle */ @@ -225,7 +225,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { /** * The page's title. Each page can have one title. - * + * * @return Returns the title of this page. */ public String getTitle() { @@ -267,7 +267,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { * <p> * Note: this call needs to get all the children of this page, and so it * will resolve this page. might be expensive. - * + * * @return Returns all the inherited styles of this page. Returns an empty * array if page is not expandable or does not have inherited * styles. @@ -291,7 +291,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { * resources from the inherited target plugin. Note: this call needs to get * all the children of this page, and so its will resolve this page. might * be expensive. - * + * * @return Returns all the inherited styles of this page. Returns an empty * hashtable if page is not expandable, does not have any includes, * or has includes that do not merge styles. @@ -306,7 +306,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { /** * Adds the given style to the list. Style is not added if it already exists * in the list. - * + * * @param style */ protected void addStyle(String style) { @@ -330,7 +330,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { /** * Adds the given style to the list.Style is not added if it already exists * in the list. - * + * * @param altStyle */ protected void addAltStyle(String altStyle, Bundle bundle) { @@ -344,7 +344,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { /** * Util method to add given styles to the list. - * + * */ protected void addStyles(String[] styles) { if (styles == null) @@ -394,7 +394,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { * Override parent behavior to lazily initialize styles vectors. This will * only be called once, if resolved == false. In the case of DOM model, * resolve this page's full DOM. - * + * * @see org.eclipse.ui.internal.intro.impl.model.AbstractIntroContainer#resolveChildren() */ @Override @@ -411,7 +411,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { /** * Override parent behavior to add support for HEAD & Title element in pages * only, and not in divs. - * + * * @see org.eclipse.ui.internal.intro.impl.model.AbstractIntroContainer#getModelChild(org.eclipse.core.runtime.IConfigurationElement) */ @Override @@ -436,7 +436,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { /** * Returns all head contributions in this page. There can be more than one * head contribution in the page; - * + * * @return */ public IntroHead[] getHTMLHeads() { @@ -501,7 +501,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { * Load the xml content from the introContent.xml file pointed to by the * content attribute, and loaded into the passed DOM. Load the first page * with correct id from this content file. - * + * * @param dom */ private void loadXMLContent(Document dom) { @@ -563,7 +563,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { * Returns the DOM representing an external XHTML file. May return null if * extension content is 3.0 format. The page is resolved before returning, * meaning includes are resolved, and the base of the page is defined. - * + * * @return */ public Document getResolvedDocument() { @@ -577,7 +577,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { * Returns the DOM representing an external XHTML file. May return null if * extension content is 3.0 format. The page is NOT resolved before * returning. It is retruned as given by the dom parser. - * + * * @return */ public Document getDocument() { @@ -592,7 +592,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { * Returns whether or not we have an XHTML page as the content for this * page. The XHTML page is defined through the content attribute. This * method forces the content file to be parsed and loaded in memory. - * + * * @return */ public boolean isXHTMLPage() { @@ -614,7 +614,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { * whether or not an xmlns was used in the xml. note: could not have used * inheritance from parent container because return type for parent is intro * legacy model. - * + * */ public Element findDomChild(String id, String localElementName) { if (!loaded) @@ -626,7 +626,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { /** * Search for any element with the given id. - * + * * @param id * @return */ @@ -670,7 +670,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { } UAElement element = UAElementFactory.newElement(dom.getDocumentElement()); domProcessor.process(element, null); - + // and resolve includes. resolveIncludes(); @@ -724,7 +724,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { * Find the target Element pointed to by the path in the include. It is * assumed that configId always points to an external config, and not the * same config of the inlcude. - * + * * @param include * @param path * @return @@ -749,7 +749,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { /** * Finds the child element that corresponds to the given path in the passed * model. - * + * * @param model * model containing target path. * @param path @@ -814,7 +814,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { /** * Used when cloning pages to assign a unique id. Cache original id before * setting. - * + * * @param id */ public void setId(String id) { @@ -846,7 +846,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { /** * Return true if this page is a cloned page that has an IFrame. - * + * * @return */ public boolean isIFramePage() { @@ -863,7 +863,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { /** * Set the url of the embedded IFrame, if this page is an IFrame page. - * + * * @param url */ public void setIFrameURL(String url) { @@ -874,7 +874,7 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { /** * Return the url of the embedded IFrame, if this page is an IFrame page. - * + * * @param url */ public String getIFrameURL() { @@ -889,10 +889,10 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { public String getInitialBase() { return initialBase; } - + /** * Return the url of the embedded IFrame, if this page is an IFrame page. - * + * * @param url */ public boolean injectSharedStyle() { @@ -900,13 +900,13 @@ public abstract class AbstractIntroPage extends AbstractIntroContainer { } /** - * Returns true if this is a dynamicpage or not. + * Returns true if this is a dynamicpage or not. * @return Returns the isDynamic. */ public boolean isDynamic() { return isDynamic; } - + /** * @return Returns the url. */ diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroPartImplementation.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroPartImplementation.java index 57ba999b5..e67662aa7 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroPartImplementation.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/AbstractIntroPartImplementation.java @@ -35,7 +35,7 @@ import org.eclipse.ui.intro.config.CustomizableIntroPart; * instantiated from plugin markup and so we need a default constructor, * including in subclasses. It has some base methods, including maintaining a * history of navigation locations. Also, dynamic awarness is honored here. - * + * */ public abstract class AbstractIntroPartImplementation { @@ -121,7 +121,7 @@ public abstract class AbstractIntroPartImplementation { /** * Creates the UI based on this implementation class. . - * + * * @param parent */ public abstract void createPartControl(Composite parent); @@ -130,7 +130,7 @@ public abstract class AbstractIntroPartImplementation { * Called when the init method is called in the IIntroPart. Subclasses may * extend, for example to get the passed Memento. When extending, make sure * you include a call to super. - * + * * @param introPart */ public void init(IIntroPart introPart, IMemento memento) { @@ -156,7 +156,7 @@ public abstract class AbstractIntroPartImplementation { /** * Updates the UI navigation history with either a real URL. - * + * * @param location */ public void updateHistory(String location) { @@ -166,7 +166,7 @@ public abstract class AbstractIntroPartImplementation { /** * Updates the UI navigation history with a page ID. - * + * * @param pageId */ public void updateHistory(AbstractIntroPage page) { @@ -178,7 +178,7 @@ public abstract class AbstractIntroPartImplementation { /** * Subclasses must implement to set the state of the navigation actions in * the toolbar. - * + * */ public abstract void setFocus(); @@ -186,7 +186,7 @@ public abstract class AbstractIntroPartImplementation { /** * Subclasses must implement to update the intro view actions when history * is updated. - * + * */ protected abstract void updateNavigationActionsState(); @@ -224,7 +224,7 @@ public abstract class AbstractIntroPartImplementation { * Called when the Intro changes state. This method should not be * subclassed. It adds performance logging calls. Subclasses must implement * doStandbyStateChanged instead. - * + * * @param standby */ public void standbyStateChanged(boolean standby, boolean isStandbyPartNeeded) { @@ -305,12 +305,12 @@ public abstract class AbstractIntroPartImplementation { * about the most recently visited intro page. In static case, the last HTML * page is remembered. In dynamic case, the last UI page or HTML page is * remembered. - * + * * Note: This method saves the last visited intro page in a dynamic case. * Subclasses need to extend to get the desired behavior relavent to the * specific implementation. Broswer implementation needs to cache an http * web page, if it happens to be the last page visited. - * + * * @param memento */ public void saveState(IMemento memento) { @@ -323,7 +323,7 @@ public abstract class AbstractIntroPartImplementation { * memento. If a given implementation requires saving alternative * information (e.g., information about the most recently visited static * page) it should override this method. - * + * * @param memento */ protected void saveCurrentPage(IMemento memento) { @@ -376,7 +376,7 @@ public abstract class AbstractIntroPartImplementation { /** * Support dynamic awarness. Clear cached models first, then update UI by * delegating to implementation. - * + * * @see org.eclipse.core.runtime.IRegistryChangeListener#registryChanged(org.eclipse.core.runtime.IRegistryChangeEvent) */ public void registryChanged(IRegistryChangeEvent event) { diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/ExtensionMap.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/ExtensionMap.java index 45666fa80..01fd0a870 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/ExtensionMap.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/ExtensionMap.java @@ -16,20 +16,20 @@ import java.util.Map; /** * This package maintains the mapping between extension ids in the registry and extension ids - * as defined in extension files. It also allows a configurer to change the page which will be + * as defined in extension files. It also allows a configurer to change the page which will be * displayed when the welcome screen is shown. */ public class ExtensionMap { - + private static ExtensionMap instance; private static String startPage; private Map<String, String> extensions = new HashMap<>(); - + private ExtensionMap() { - + } - + /** * Get the one and only instance of this class * @return @@ -51,9 +51,9 @@ public class ExtensionMap { extensions.put(anchorId, pluginId); } } - + /** - * Lookup in which plugin + * Lookup in which plugin * @param anchorId * @return the plugin which contributed that anchor */ @@ -76,9 +76,9 @@ public class ExtensionMap { public String getStartPage() { return startPage; } - + /** - * Allows a configurer to override the page which is displayed when + * Allows a configurer to override the page which is displayed when * the welcome screen is first shown * @param contentPage */ diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/History.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/History.java index 4d7f6a4c8..ecf503b23 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/History.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/History.java @@ -50,7 +50,7 @@ public class History { /** * returns the history page. If iframe page, updated to correct url. - * + * * @return */ AbstractIntroPage getPage() { @@ -91,7 +91,7 @@ public class History { /** * Updates the UI navigation history with either a real URL, or a page ID. - * + * * @param pageId */ public void updateHistory(String location) { @@ -104,7 +104,7 @@ public class History { /** * Updates the UI navigation history with either a real URL, or a page ID. - * + * * @param page */ public void updateHistory(AbstractIntroPage page) { @@ -162,7 +162,7 @@ public class History { // point the nav location to the end of the vector. navigationLocation = getHistoryEndPosition(); } - + public void removeLastHistory() { history.remove(getHistoryEndPosition()); // point the nav location to the end of the vector. @@ -180,7 +180,7 @@ public class History { /** * Return the position of the last element in the navigation history. If * vector is empty, return 0. - * + * * @param vector * @return */ @@ -199,7 +199,7 @@ public class History { /** * Navigate forward in the history. - * + * * @return */ public void navigateHistoryForward() { @@ -221,7 +221,7 @@ public class History { /** * Returns true if the current location in the navigation history represents * a URL. False if the location is an Intro Page id. - * + * * @return Returns the locationIsURL. */ private HistoryObject getCurrentLocation() { diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroContentProvider.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroContentProvider.java index 43f7acad3..83145aa7b 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroContentProvider.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroContentProvider.java @@ -21,7 +21,7 @@ import org.w3c.dom.Element; * implement the IIntroContentProvider interface. The pluginId attribute can be * used if the class doesn't come from the plugin that defined the markup. The * text content should be used only if we fail to load the class. <br> - * + * * INTRO: model class has access to style-id attribute but it is not used in the * schema. */ @@ -44,7 +44,7 @@ public class IntroContentProvider extends AbstractTextElement { /** * Returns the content provider, which should implement * IIntroContentProvider - * + * * @return Returns the contentProvider. */ public String getClassName() { @@ -53,7 +53,7 @@ public class IntroContentProvider extends AbstractTextElement { /** * Returns the id of the plugin that contains the content provider class - * + * * @return Returns the pluginId. */ public String getPluginId() { diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroExtensionContent.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroExtensionContent.java index cfb562284..5453202be 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroExtensionContent.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroExtensionContent.java @@ -43,7 +43,7 @@ public class IntroExtensionContent extends AbstractIntroElement { public static final int TYPE_CONTRIBUTION = 0; public static final int TYPE_REPLACEMENT = 1; - + protected static final String ATT_PATH = "path"; //$NON-NLS-1$ protected static final String ATT_ID = "id"; //$NON-NLS-1$ private static final String ATT_STYLE = "style"; //$NON-NLS-1$ @@ -87,12 +87,12 @@ public class IntroExtensionContent extends AbstractIntroElement { bundle); this.base = newBase; } - + // Save the mapping between plugin registry id and base/anchor id String contributor = configExtElement.getContributor().getName(); ExtensionMap.getInstance().putPluginId(anchorId, contributor); } - + public String getId() { return anchorId; } @@ -102,7 +102,7 @@ public class IntroExtensionContent extends AbstractIntroElement { * Initialize styles. Take first style in style attribute and make it the * page style. Then put other styles in styles vectors. Make sure to resolve * each style. - * + * * @param element * @param bundle */ @@ -131,7 +131,7 @@ public class IntroExtensionContent extends AbstractIntroElement { /** * Adds the given style to the list. Style is not added if it already exists * in the list. - * + * * @param style */ protected void addStyle(String style) { @@ -144,7 +144,7 @@ public class IntroExtensionContent extends AbstractIntroElement { /** * Adds the given style to the list.Style is not added if it already exists * in the list. - * + * * @param altStyle */ protected void addAltStyle(String altStyle, Bundle bundle) { @@ -197,7 +197,7 @@ public class IntroExtensionContent extends AbstractIntroElement { * that should be inserted for the extension. If it is a file, all child elements * of body are returned. If it is a file with an id, only the element with the id * is returned. - * + * * @return the elements to be inserted */ public Element[] getElements() { @@ -250,13 +250,13 @@ public class IntroExtensionContent extends AbstractIntroElement { public String getBase() { return base; } - + /** * Extracts the file and id parts of the content attribute. This attribute has two modes - * if you specify a file, it will include the body of that file (minus the body element itself). * If you append an id after the file, only the element with that id will be included. However * we need to know which mode we're in. - * + * * @param bundle the bundle that contributed this extension */ private void extractFileAndId(Bundle bundle) { diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroGroup.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroGroup.java index 2ab39b642..49e8b7b46 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroGroup.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroGroup.java @@ -38,11 +38,11 @@ public class IntroGroup extends AbstractIntroContainer { IntroGroup(Element element, Bundle bundle, String base) { super(element, bundle, base); } - + @Override protected void loadFromParent() { } - + private void resolve() { // reinitialize if there are variables in the value. if (label==null) { @@ -66,22 +66,22 @@ public class IntroGroup extends AbstractIntroContainer { resolve(); return label; } - + @Override public int getType() { return AbstractIntroElement.GROUP; } - + public boolean isExpandable() { String value=getAttribute(element, ATT_EXPANDABLE); return value!=null && value.equalsIgnoreCase("true"); //$NON-NLS-1$ } - + public boolean isExpanded() { String value=getAttribute(element, ATT_EXPANDED); return value!=null && value.equalsIgnoreCase("true"); //$NON-NLS-1$ } - + @Override protected void loadChildren() { String value = getAttribute(element, ATT_COMPUTED); @@ -102,7 +102,7 @@ public class IntroGroup extends AbstractIntroContainer { addDynamicNodes(this.element, nodes); } } - + private void addDynamicNodes(Element target, IntroElement [] nodes) { for (int i=0; i<nodes.length; i++) { IntroElement node = nodes[i]; diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroHTML.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroHTML.java index ccd5d1059..83ceec7f9 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroHTML.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroHTML.java @@ -85,7 +85,7 @@ public class IntroHTML extends AbstractTextElement { /** * Returns the html type. Will be either "inline" or "embed". If not, null * will be returned as if the attibute was nto defined. - * + * * @return Returns the html type value. */ public boolean isInlined() { @@ -111,7 +111,7 @@ public class IntroHTML extends AbstractTextElement { /** * Returns the intro image used as a replacement if this HTML element fails. * May return null if there is no image child. - * + * * @return Returns the introImage. */ public IntroImage getIntroImage() { diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroImage.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroImage.java index 83aa01834..a13f8bf4b 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroImage.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroImage.java @@ -42,7 +42,7 @@ public class IntroImage extends AbstractBaseIntroElement { public String getAlt() { return getAttribute(element, ATT_ALT); } - + /** * @return Returns the title. */ diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroLaunchBarElement.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroLaunchBarElement.java index d23ded6cf..e2f9c3b2b 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroLaunchBarElement.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroLaunchBarElement.java @@ -26,7 +26,7 @@ import org.eclipse.ui.intro.config.IntroElement; * An Intro Config component captures launch bar information. It can have * shortcuts and one handle. <br> * ps: Handles are not modeled in a dedicated class, but are handled here. - * + * * @since 3.1 */ public class IntroLaunchBarElement extends AbstractIntroElement { @@ -50,7 +50,7 @@ public class IntroLaunchBarElement extends AbstractIntroElement { * Returns the desired launch bar orientation that results from the desired * location. Valid values are <code>SWT.VERTICAL</code> and * <code>SWT.HORIZONTAL</code>. - * + * * @return */ public int getOrientation() { @@ -63,7 +63,7 @@ public class IntroLaunchBarElement extends AbstractIntroElement { * Returns the location of the launch bar in the workbench window. Valid * values are <code>SWT.RIGHT</code>,<code>SWT.LEFT</code> and * <code>SWT.BOTTOM</code>. - * + * * @return */ public int getLocation() { @@ -113,7 +113,7 @@ public class IntroLaunchBarElement extends AbstractIntroElement { /** * Returns the relative icon path of the handle image. - * + * * @return */ private String getHandleImage() { @@ -126,7 +126,7 @@ public class IntroLaunchBarElement extends AbstractIntroElement { /** * Returns the icon image of the handle, or <code>null</code> if not * defined or found. - * + * * @return */ public ImageDescriptor getHandleImageDescriptor() { @@ -146,7 +146,7 @@ public class IntroLaunchBarElement extends AbstractIntroElement { /** * Returns an array of shorcut elements. - * + * * @return */ public IntroLaunchBarShortcut[] getShortcuts() { @@ -159,16 +159,16 @@ public class IntroLaunchBarElement extends AbstractIntroElement { /** * Creates an array of shortcut elements - * + * */ private void createShortcuts() { shortcuts = new ArrayList<>(); IntroModelRoot model = getModelRoot(); IntroConfigurer configurer = model!=null?model.getConfigurer():null; - + String cvalue = getCfgElement().getAttribute("computed"); //$NON-NLS-1$ boolean computed = cvalue!=null && cvalue.equalsIgnoreCase("true"); //$NON-NLS-1$ - + if (computed && configurer!=null) { IntroElement [] children = configurer.getLaunchBarShortcuts(); for (int i=0; i<children.length; i++) { diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroLaunchBarShortcut.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroLaunchBarShortcut.java index ba839693d..406f4c5a8 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroLaunchBarShortcut.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroLaunchBarShortcut.java @@ -20,7 +20,7 @@ import org.eclipse.ui.intro.config.IntroElement; /** * An Intro Config component that captures launch bar shortcut information. - * + * * @since 3.1 */ public class IntroLaunchBarShortcut extends AbstractIntroElement { @@ -30,14 +30,14 @@ public class IntroLaunchBarShortcut extends AbstractIntroElement { private static final String ATT_TOOLTIP = "tooltip"; //$NON-NLS-1$ private static final String ATT_ICON = "icon"; //$NON-NLS-1$ private static final String ATT_URL = "url"; //$NON-NLS-1$ - + private IntroElement ielement; - + IntroLaunchBarShortcut(IConfigurationElement element, IntroElement ielement) { super(element); this.ielement = ielement; } - + IntroLaunchBarShortcut(IConfigurationElement element) { super(element); } @@ -47,7 +47,7 @@ public class IntroLaunchBarShortcut extends AbstractIntroElement { public int getType() { return AbstractIntroElement.LAUNCH_BAR_SHORTCUT; } - + private String getAttribute(String name) { if (ielement!=null) return ielement.getAttribute(name); @@ -56,7 +56,7 @@ public class IntroLaunchBarShortcut extends AbstractIntroElement { /** * Returns the URL of this shortcut. - * + * * @return */ public String getURL() { @@ -65,7 +65,7 @@ public class IntroLaunchBarShortcut extends AbstractIntroElement { /** * Returns the tooltip of this shortcut. - * + * * @return */ public String getToolTip() { @@ -74,7 +74,7 @@ public class IntroLaunchBarShortcut extends AbstractIntroElement { /** * Returns the relative icon path of this shortcut. - * + * * @return */ private String getIcon() { @@ -84,7 +84,7 @@ public class IntroLaunchBarShortcut extends AbstractIntroElement { /** * Returns the icon image of this shortcut, or <code>null</code> if not * found. - * + * * @return */ public ImageDescriptor getImageDescriptor() { diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroLink.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroLink.java index d8ce46549..c9f2b36c9 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroLink.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroLink.java @@ -81,7 +81,7 @@ public class IntroLink extends AbstractTextElement { /** * Retruns an IntroURL instance if link has a valid intro url. Returns null * otherwise. - * + * * @return Returns the introURL. */ public IntroURL getIntroURL() { diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroModelRoot.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroModelRoot.java index 4e8c114d4..109c80bc5 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroModelRoot.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroModelRoot.java @@ -46,7 +46,7 @@ import org.w3c.dom.Node; /** * The root class for the OOBE model. It loads the configuration into the * appropriate classes. - * + * * Model rules: * <ol> * <li>if an attribute is not included in the markup, its value will be null in @@ -133,7 +133,7 @@ public class IntroModelRoot extends AbstractIntroContainer { public ListenerList<IPropertyListener> propChangeListeners = new ListenerList<>(); // a list to hold all loaded DOMs until resolving all configExtensions - // is done. + // is done. private List<ExtensionContent> unresolvedConfigExt = new ArrayList<>(); @@ -172,7 +172,7 @@ public class IntroModelRoot extends AbstractIntroContainer { * extension pages and groups. The presentation is loaded from the * IConfiguration element representing the config. All else is loaded from * xml content file. - * + * */ @Override protected void loadChildren() { @@ -189,7 +189,7 @@ public class IntroModelRoot extends AbstractIntroContainer { Log.warning("Could not find presentation element in intro config."); //$NON-NLS-1$ return; } - + loadTheme(); loadConfigurer(); @@ -232,7 +232,7 @@ public class IntroModelRoot extends AbstractIntroContainer { * presentation as the first child, so use that fact. This method is used * for dynamic awarness to enable replacing the new presentation with the * existing one after a model refresh. - * + * * @param presentation */ public void setPresentation(IntroPartPresentation presentation) { @@ -262,7 +262,7 @@ public class IntroModelRoot extends AbstractIntroContainer { IntroPartPresentation.ATT_HOME_PAGE_ID); return presentationElement; } - + private void loadConfigurer() { String cname = getCfgElement().getAttribute(ATT_CONFIGURER); if (cname!=null) { @@ -277,7 +277,7 @@ public class IntroModelRoot extends AbstractIntroContainer { } } } - + private void determineHomePage() { String pid = Platform.getProduct().getId(); startPageId = getProcessPreference("INTRO_START_PAGE", pid); //$NON-NLS-1$ @@ -308,11 +308,11 @@ public class IntroModelRoot extends AbstractIntroContainer { standbyPage.setStandbyPage(true); } } - + private void loadTheme() { String pid = Platform.getProduct().getId(); String themeId = getProcessPreference("INTRO_THEME", pid); //$NON-NLS-1$ - + IConfigurationElement [] elements = Platform.getExtensionRegistry().getConfigurationElementsFor("org.eclipse.ui.intro.configExtension"); //$NON-NLS-1$ IConfigurationElement themeElement=null; for (int i=0; i<elements.length; i++) { @@ -389,9 +389,9 @@ public class IntroModelRoot extends AbstractIntroContainer { for (int i = 0; i < configExtensionElements.length; i++) { processConfigExtension(configExtensionElements[i]); } - + tryResolvingExtensions(); - + // At this stage all pages will be resolved, some contributions may not be // now add all unresolved extensions as model children and log fact. @@ -471,8 +471,8 @@ public class IntroModelRoot extends AbstractIntroContainer { Bundle bundle = BundleUtil.getBundleFromConfigurationElement(configExtElement); String elementBase = getBase(configExtElement); processOneExtension(configExtElement, elementBase, bundle, extensionContentElement); - if (extensionContentElement.hasAttribute("failed")) { //$NON-NLS-1$ - stillUnresolved.add(content); + if (extensionContentElement.hasAttribute("failed")) { //$NON-NLS-1$ + stillUnresolved.add(content); } } unresolvedConfigExt = stillUnresolved; @@ -486,10 +486,10 @@ public class IntroModelRoot extends AbstractIntroContainer { * not include the page and group contributions as part of the model. If * extension content has XHTML content (ie: content attribute is defined) we * load extension DOM into target page dom. - * + * * note: the extension Element is returned to enable creating a child model * element on failure. - * + * * @param * @return */ @@ -506,7 +506,7 @@ public class IntroModelRoot extends AbstractIntroContainer { addUnfilteredExtensions(elements, extensionContents); addUnfilteredExtensions(elements, replacementContents); - + return (Element[])elements.toArray(new Element[elements.size()]); } @@ -515,7 +515,7 @@ public class IntroModelRoot extends AbstractIntroContainer { Element extensionContentElement = extensionContents[i]; if (!UAContentFilter.isFiltered(UAElementFactory.newElement(extensionContentElement), IntroEvaluationContext.getContext())) { elements.add(extensionContentElement); - } + } } } @@ -540,7 +540,7 @@ public class IntroModelRoot extends AbstractIntroContainer { /** * Insert the extension content into the target. - * + * * @param extensionContent * @return */ @@ -582,7 +582,7 @@ public class IntroModelRoot extends AbstractIntroContainer { if (extensionContent.getExtensionType() == IntroExtensionContent.TYPE_REPLACEMENT) { targetElement.getParentNode().removeChild(targetElement); } - + // now handle style inheritance. // Update the parent page styles. skip style if it is null; String[] styles = extensionContent.getStyles(); @@ -599,7 +599,7 @@ public class IntroModelRoot extends AbstractIntroContainer { /** * Insert the extension content (3.0 format) into the target. - * + * * @param extensionContent * @return */ @@ -630,7 +630,7 @@ public class IntroModelRoot extends AbstractIntroContainer { Element [] children = extensionContent.getChildren(); parent.insertElementsBefore(children, bundle, base, target, mixinStyle); } - + private String getMixinStyle(IntroExtensionContent extensionContent) { String path = extensionContent.getPath(); if (!path.endsWith("/@")) //$NON-NLS-1$ @@ -660,7 +660,7 @@ public class IntroModelRoot extends AbstractIntroContainer { * configExtension. If we are extending a shared group do nothing. For * inherited alt-styles, we have to cache the bundle from which we inherited * the styles to be able to access resources in that plugin. - * + * * @param include * @param target */ @@ -686,7 +686,7 @@ public class IntroModelRoot extends AbstractIntroContainer { } /** - * Sets the model state based on all the model classes. + * Sets the model state based on all the model classes. */ private void setModelState(boolean loaded, boolean hasValidConfig) { this.loaded = loaded; @@ -697,7 +697,7 @@ public class IntroModelRoot extends AbstractIntroContainer { * Returns true if there is a valid contribution to * org.eclipse.ui.intro.config extension point, with a valid Presentation, * and pages. - * + * * @return Returns the hasValidConfig. */ public boolean hasValidConfig() { @@ -710,7 +710,7 @@ public class IntroModelRoot extends AbstractIntroContainer { public IntroPartPresentation getPresentation() { return introPartPresentation; } - + public IntroConfigurer getConfigurer() { return configurer; } @@ -721,7 +721,7 @@ public class IntroModelRoot extends AbstractIntroContainer { public AbstractIntroPage getHomePage() { return homePage; } - + /** * @return Returns the root Page. */ @@ -767,7 +767,7 @@ public class IntroModelRoot extends AbstractIntroContainer { /** * Sets the current page. If the model does not have a page with the passed * id, the message is logged, and the model retains its old current page. - * + * * @param currentPageId * The currentPageId to set. * * @param fireEvent @@ -811,7 +811,7 @@ public class IntroModelRoot extends AbstractIntroContainer { /** * Fires a property changed event. Made public because it can be used to * trigger a UI refresh. - * + * * @param propertyId * the id of the property that changed */ @@ -872,7 +872,7 @@ public class IntroModelRoot extends AbstractIntroContainer { * the configExt content files. ie: in plugin.xml. <br> * This method also sets the base attribute on the root element in the DOM * to enable resolving all resources relative to this DOM. - * + * * @return */ protected Document loadDOM(IConfigurationElement cfgElement) { @@ -898,7 +898,7 @@ public class IntroModelRoot extends AbstractIntroContainer { String content = configElement.getAttribute(ATT_CONTENT); return ModelUtil.getParentFolderToString(content); } - + public String resolveVariables(String text) { if (text==null) return null; if (text.indexOf('$')== -1) @@ -942,20 +942,20 @@ public class IntroModelRoot extends AbstractIntroContainer { return "rtl"; //$NON-NLS-1$ } else { return "ltr"; //$NON-NLS-1$ - } + } } - + if (configurer!=null) return configurer.getVariable(variable); return null; } - + public String resolvePath(String extensionId, String path) { if (configurer==null) return null; return configurer.resolvePath(extensionId, path); } - + public IntroTheme getTheme() { return theme; } @@ -963,13 +963,13 @@ public class IntroModelRoot extends AbstractIntroContainer { public String getStartPageId() { return startPageId; } - + private String getProcessPreference(String key, String pid) { String result = Platform.getPreferencesService().getString - (IntroPlugin.PLUGIN_ID, pid + '_' + key, "", null); //$NON-NLS-1$ + (IntroPlugin.PLUGIN_ID, pid + '_' + key, "", null); //$NON-NLS-1$ if (result.length() == 0) { result = Platform.getPreferencesService().getString - (IntroPlugin.PLUGIN_ID, key, "", null); //$NON-NLS-1$ + (IntroPlugin.PLUGIN_ID, key, "", null); //$NON-NLS-1$ } return result; } diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroPartPresentation.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroPartPresentation.java index cc7fead3d..fcbc602da 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroPartPresentation.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroPartPresentation.java @@ -90,7 +90,7 @@ public class IntroPartPresentation extends AbstractIntroElement { private IMemento memento; /** - * + * */ IntroPartPresentation(IConfigurationElement element) { super(element); @@ -131,7 +131,7 @@ public class IntroPartPresentation extends AbstractIntroElement { /** * Returns the styles associated with the Presentation. May be null if no shared presentation * style is needed, or in the case of static HTML OOBE. - * + * * @return Returns the array of styles or null if not defined. */ public String[] getImplementationStyles() { @@ -140,7 +140,7 @@ public class IntroPartPresentation extends AbstractIntroElement { /** * Returns the type attribute of the implementation picked by this presentation. - * + * * @return Returns the implementationKind. */ public String getImplementationKind() { @@ -155,7 +155,7 @@ public class IntroPartPresentation extends AbstractIntroElement { /** * Returns the model class for the Head element under an implementation. Returns null if there * is no head contribution. - * + * * @param element * @return */ @@ -179,7 +179,7 @@ public class IntroPartPresentation extends AbstractIntroElement { /** * Returns the launch bar element if defined in this presentation, or <code>null</code> * otherwise. - * + * * @since 3.1 * @return */ @@ -211,7 +211,7 @@ public class IntroPartPresentation extends AbstractIntroElement { /** * Creates the UI based on the implementation class. - * + * * @see org.eclipse.ui.IWorkbenchPart#createPartControl(org.eclipse.swt.widgets.Composite) */ public void createPartControl(Composite parent) { @@ -344,7 +344,7 @@ public class IntroPartPresentation extends AbstractIntroElement { /** * Util method that searches for the given value in a comma separated list of values. The list * is retrieved as an attribute value of OS, WS. - * + * */ private boolean listValueHasValue(String stringValue, String value) { String[] attributeValues = StringUtil.split(stringValue, ","); //$NON-NLS-1$ @@ -382,7 +382,7 @@ public class IntroPartPresentation extends AbstractIntroElement { /** * Creates the actual implementation class. Returns null on failure. - * + * */ private AbstractIntroPartImplementation createIntroPartImplementation(String implementationType) { // quick exits @@ -391,14 +391,14 @@ public class IntroPartPresentation extends AbstractIntroElement { if (!implementationType.equals(BROWSER_IMPL_KIND) && !implementationType.equals(FORMS_IMPL_KIND) && !implementationType.equals(TEXT_IMPL_KIND)) return null; - if (implementationType.equals(BROWSER_IMPL_KIND) && IntroPlugin.DEBUG_NO_BROWSER) + if (implementationType.equals(BROWSER_IMPL_KIND) && IntroPlugin.DEBUG_NO_BROWSER) return null; AbstractIntroPartImplementation implementation = null; try { if (implementationType.equals(BROWSER_IMPL_KIND)) - implementation = //null; - new BrowserIntroPartImplementation(); + implementation = //null; + new BrowserIntroPartImplementation(); else if (implementationType.equals(FORMS_IMPL_KIND)) implementation = new FormIntroPartImplementation(); else @@ -413,7 +413,7 @@ public class IntroPartPresentation extends AbstractIntroElement { /** * Returns the the Customizable Intro Part. may return null if init() has not been called yet on * the presentation. - * + * * @return Returns the introPart. */ public IIntroPart getIntroPart() { @@ -423,7 +423,7 @@ public class IntroPartPresentation extends AbstractIntroElement { /** * Save the current state of the intro. Delegate to the implementation to do the work, as * different implementations may have different requirements. - * + * * @param memento * the memento in which to store state information */ @@ -480,7 +480,7 @@ public class IntroPartPresentation extends AbstractIntroElement { /** * Support dynamic awarness. Clear cached models first, then update UI by delegating to * implementation. - * + * * @see org.eclipse.core.runtime.IRegistryChangeListener#registryChanged(org.eclipse.core.runtime.IRegistryChangeEvent) */ public void registryChanged(IRegistryChangeEvent event) { diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroSearchParticipant.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroSearchParticipant.java index 54ef23355..923da20af 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroSearchParticipant.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroSearchParticipant.java @@ -34,13 +34,13 @@ import org.osgi.framework.Bundle; /** * An implementation of SearchParticipant that adds Welcome content into the local help * index so that it can be searched. - * + * */ public class IntroSearchParticipant extends SearchParticipant { private IntroModelRoot model; - + private class TitleAndSummary { String title; String summary; @@ -165,7 +165,7 @@ public class IntroSearchParticipant extends SearchParticipant { addTitle(titleSummary.title, doc); } if (titleSummary.summary != null) { - doc.setSummary(titleSummary.summary); + doc.setSummary(titleSummary.summary); } doc.addContents(contents); return Status.OK_STATUS; @@ -195,11 +195,11 @@ public class IntroSearchParticipant extends SearchParticipant { } if (title != null) { titleSummary.title = title; - } + } if ("page-description".equals(childId)) { //$NON-NLS-1$ - titleSummary.summary = childIntroText.getText(); + titleSummary.summary = childIntroText.getText(); } - } + } if (child instanceof AbstractIntroContainer) { AbstractIntroContainer container = (AbstractIntroContainer) child; if (!"navigation-links".equals(container.getId())) { //$NON-NLS-1$ diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroStandbyContentPart.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroStandbyContentPart.java index 408134009..64eda363e 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroStandbyContentPart.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroStandbyContentPart.java @@ -31,7 +31,7 @@ public class IntroStandbyContentPart extends AbstractIntroIdElement { /** * Note: model class with public constructor because it is not instantiated * by the model root. - * + * * @param element */ public IntroStandbyContentPart(IConfigurationElement element) { diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroTheme.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroTheme.java index ffd539fd4..0c39a330d 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroTheme.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/IntroTheme.java @@ -27,7 +27,7 @@ public class IntroTheme extends AbstractIntroIdElement { private String path; private Hashtable<String, String> properties; private boolean scalable; - + public IntroTheme(IConfigurationElement element) { super(element); name = element.getAttribute(ATT_NAME); @@ -44,11 +44,11 @@ public class IntroTheme extends AbstractIntroIdElement { public IntroTheme(Element element, Bundle bundle, String base) { super(element, bundle, base); } - + public String getName() { return name; } - + public String getPath() { return path; } @@ -57,15 +57,15 @@ public class IntroTheme extends AbstractIntroIdElement { public int getType() { return THEME; } - + public Map<String, String> getProperties() { return properties; } - + public boolean isScalable() { return scalable; } - + private void loadProperties(IConfigurationElement element) { IConfigurationElement [] children = element.getChildren("property"); //$NON-NLS-1$ if (children.length==0) diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/BaseExtensionPointManager.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/BaseExtensionPointManager.java index 4d8f4c398..d7de96cc3 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/BaseExtensionPointManager.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/BaseExtensionPointManager.java @@ -119,7 +119,7 @@ public class BaseExtensionPointManager { * that maps to the correct intro part id. If there is more than one config * thats maps to the same intro part id, log the fact, and return the first * one. If there are non, return null. - * + * * @param configElements * @return */ @@ -150,7 +150,7 @@ public class BaseExtensionPointManager { IConfigurationElement[] configExtensionElements = registry .getConfigurationElementsFor(CONFIG_EXTENSION); - + /* * Extension filter is used for performance testing to only load contributions * from a specific plug-in (fixed data set). @@ -174,7 +174,7 @@ public class BaseExtensionPointManager { /** * Add a model to the cache. This method is private because only this * manager class knows how to load an intro model. - * + * * @param modelId * @param model */ @@ -184,7 +184,7 @@ public class BaseExtensionPointManager { /** * Gets the given model from the cache. - * + * * @param modelId */ protected IntroModelRoot getCachedModel(String configId) { @@ -196,7 +196,7 @@ public class BaseExtensionPointManager { * with an attribute of the given value. If there is more than one * configuration element that maps to the attribute value log the fact, and * return the first one. If there are non, return null. - * + * * @param configElements * @return */ @@ -263,7 +263,7 @@ public class BaseExtensionPointManager { public Map<String, IntroModelRoot> getIntroModels() { return introModels; } - + /* * Internal test hook for restricting which extensions to load. */ diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/ContentProviderManager.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/ContentProviderManager.java index 550400325..fc545bca8 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/ContentProviderManager.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/ContentProviderManager.java @@ -89,7 +89,7 @@ public class ContentProviderManager { /** * Retrieve an existing content provider class, or null if never created before. - * + * * @param provider * @return */ @@ -107,7 +107,7 @@ public class ContentProviderManager { /** * Tries to create an intro content provider class. may return null if creation fails. This will * be logged. - * + * * @param provider * @param site * @return diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/ExtensionPointManager.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/ExtensionPointManager.java index 80a69e114..18a2eba8a 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/ExtensionPointManager.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/ExtensionPointManager.java @@ -76,7 +76,7 @@ public class ExtensionPointManager extends BaseExtensionPointManager { /** * Load an intro model given a config id. - * + * * @param configId * @return */ diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/IntroContentParser.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/IntroContentParser.java index 6555f4966..3f56b59f1 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/IntroContentParser.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/IntroContentParser.java @@ -36,7 +36,7 @@ import org.xml.sax.SAXParseException; /** - * + * */ public class IntroContentParser { @@ -94,7 +94,7 @@ public class IntroContentParser { buffer.append(spe.getLineNumber()); buffer.append(", uri "); //$NON-NLS-1$ buffer.append(spe.getSystemId()); - buffer.append("\n"); //$NON-NLS-1$ + buffer.append("\n"); //$NON-NLS-1$ buffer.append(spe.getMessage()); // Use the contained exception. @@ -123,7 +123,7 @@ public class IntroContentParser { /** * Returned the DOM representing the intro xml content file. May return null * if parsing the file failed. - * + * * @return Returns the document. */ public Document getDocument() { diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/ModelLoaderUtil.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/ModelLoaderUtil.java index 162ae121b..17328f01e 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/ModelLoaderUtil.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/ModelLoaderUtil.java @@ -29,7 +29,7 @@ public class ModelLoaderUtil { /** * Utility method to validate an elements name. - * + * * @param element * @param validName * @return @@ -48,7 +48,7 @@ public class ModelLoaderUtil { * passed array of elements. If the array is empty, null is returned. If * there is more than one element in the array, the first one is picked, but * this fact is logged. Attribute passed is used for logging. - * + * * @param configElements * @return the first configElement in the array, or null if the array is * empty. @@ -127,7 +127,7 @@ public class ModelLoaderUtil { /** * Util class for creating class instances from plugins. - * + * * @param pluginId * @param className * @return @@ -158,7 +158,7 @@ public class ModelLoaderUtil { /** * Creates a key for the given element. Returns null if any id is null along * the path. - * + * * @param element * @return */ diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/SharedConfigExtensionsManager.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/SharedConfigExtensionsManager.java index fe37646d0..ccfc3a9fa 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/SharedConfigExtensionsManager.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/loader/SharedConfigExtensionsManager.java @@ -78,7 +78,7 @@ public class SharedConfigExtensionsManager { /** * Create an intro standby part or an intro command model class. - * + * * @param element */ private void createModelClass(IConfigurationElement element) { diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/url/IntroURL.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/url/IntroURL.java index 17b942dcc..40734c936 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/url/IntroURL.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/url/IntroURL.java @@ -123,7 +123,7 @@ public class IntroURL implements IIntroURL { /** * Prevent creation. Must be created through an IntroURLParser. This * constructor assumed we have a valid intro url. - * + * * @param url */ IntroURL(String action, Properties parameters) { @@ -133,13 +133,13 @@ public class IntroURL implements IIntroURL { /** * Executes whatever valid Intro action is embedded in this Intro URL. - * + * */ @Override public boolean execute() { final boolean[] result = new boolean[1]; Display display = Display.getCurrent(); - + BusyIndicator.showWhile(display, () -> result[0] = doExecute()); return result[0]; } @@ -189,7 +189,7 @@ public class IntroURL implements IIntroURL { // the parameters and the standby state. return runAction(getParameter(KEY_PLUGIN_ID), getParameter(KEY_CLASS), parameters, getParameter(KEY_STANDBY)); - + else if (action.equals(EXECUTE)) // execute a serialized command return executeCommand(getParameter(KEY_COMAND), getParameter(KEY_STANDBY)); @@ -220,7 +220,7 @@ public class IntroURL implements IIntroURL { /** * Sets the into part to standby, and shows the passed standby part, with * the given input. Forces the Intro view to open, if not yet created. - * + * * @param partId * @param input */ @@ -248,10 +248,10 @@ public class IntroURL implements IIntroURL { /** * Set the Workbench Intro Part state. Forces the Intro view to open, if not yet created. - * + * * Historically this value was "true" (show standby) or "false" (show normal). In Neon we add * "close", "standby" and "launchbar". - * + * * @param state * @return true if the intro was shown, or false if the intro could not be shown */ @@ -315,7 +315,7 @@ public class IntroURL implements IIntroURL { return false; } } - + /** * Executes a serialized <code>ParameterizedCommand</code>. Uses * {@link ICommandService#deserialize(String)} to convert the <code>command</code> argument @@ -342,9 +342,9 @@ public class IntroURL implements IIntroURL { return false; } } - + private ICommandService getCommandService() { - IWorkbench wb = PlatformUI.getWorkbench(); + IWorkbench wb = PlatformUI.getWorkbench(); if (wb != null) { Object serviceObject = wb.getAdapter(ICommandService.class); if (serviceObject != null) { @@ -356,7 +356,7 @@ public class IntroURL implements IIntroURL { } private IHandlerService getHandlerService() { - IWorkbench wb = PlatformUI.getWorkbench(); + IWorkbench wb = PlatformUI.getWorkbench(); if (wb != null) { Object serviceObject = wb.getAdapter(IHandlerService.class); if (serviceObject != null) { @@ -475,7 +475,7 @@ public class IntroURL implements IIntroURL { /** * Finds the target page and includes it in passed model. - * + * * @param pageId * @return */ @@ -523,7 +523,7 @@ public class IntroURL implements IIntroURL { /** * Searches all loaded models for the first page with the given id. - * + * * @param pageId * @return */ @@ -541,7 +541,7 @@ public class IntroURL implements IIntroURL { /** * Navigate foward in the presentation, whichever one it is. - * + * * @return */ private boolean navigate(String direction) { @@ -577,7 +577,7 @@ public class IntroURL implements IIntroURL { * Return a parameter defined in the Intro URL. Returns null if the * parameter is not defined. If this intro url has a decode=true parameter, * then all parameters are returned decoded using UTF-8. - * + * * @param parameterId * @return */ @@ -633,7 +633,7 @@ public class IntroURL implements IIntroURL { /** * Recreate the initial query passed to this URL. - * + * * @return */ private String retrieveInitialQuery() { @@ -675,7 +675,7 @@ public class IntroURL implements IIntroURL { Rectangle endBounds = Geometry.toDisplay(launchBar.getControl() .getParent(), launchBar.getControl().getBounds()); - AnimationEngine.createTweakedAnimation(window.getShell(), 400, startBounds, endBounds); + AnimationEngine.createTweakedAnimation(window.getShell(), 400, startBounds, endBounds); return true; } } diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/url/IntroURLParser.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/url/IntroURLParser.java index 308d774e5..696a30d3c 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/url/IntroURLParser.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/url/IntroURLParser.java @@ -97,7 +97,7 @@ public class IntroURLParser { * Checks to see if tha passed URL is an Intro URL. An intro URL is an http * URL that has the intro plugin id as a host. eg: * "http://org.eclipse.ui.intro/test". - * + * * @param url * @return true if url is an intro URL. */ @@ -136,7 +136,7 @@ public class IntroURLParser { /** * Retruns the path attribute of the passed URL, stripped out of the leading * "/". Returns null if the url does not have a path. - * + * * @param url * @return */ @@ -151,7 +151,7 @@ public class IntroURLParser { /** * Retruns the Query part of the URL as an instance of a Properties class. - * + * * @param url * @return */ @@ -176,7 +176,7 @@ public class IntroURLParser { + params[i]); continue; } - + String key = urlDecode(keyValuePair[0]); if (key == null) { Log.warning("Failed to URL decode key: " + keyValuePair[0]); //$NON-NLS-1$ @@ -188,7 +188,7 @@ public class IntroURLParser { Log.warning("Failed to URL decode value: " + keyValuePair[1]); //$NON-NLS-1$ continue; } - + properties.setProperty(key, value); } return properties; diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/util/BundleUtil.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/util/BundleUtil.java index 0828fcca2..24b75fa60 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/util/BundleUtil.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/util/BundleUtil.java @@ -60,7 +60,7 @@ public class BundleUtil { /** * Retrieves the given key from the bundle header. - * + * * @param bundle * @param key * @return @@ -78,7 +78,7 @@ public class BundleUtil { /** * Get the resourcelocation, but do not force an $nl$ on it. - * + * * @param resource * @param element * @return @@ -94,7 +94,7 @@ public class BundleUtil { * Returns the fully qualified location of the passed resource string from * the passed plugin id. If the file could not be loaded from the plugin, * the resource is returned as is. - * + * * @param resource * @return */ @@ -107,7 +107,7 @@ public class BundleUtil { /** * Shorthand util method. - * + * * @param resource * @return */ @@ -168,7 +168,7 @@ public class BundleUtil { } } } - + // we need to resolve this URL. String copyResource = resource; if (forceNLResolve && !copyResource.startsWith(NL_TAG)) { @@ -224,7 +224,7 @@ public class BundleUtil { /** * Get the absolute path of the given bundle, in the form * file:/path_to_plugin - * + * * @param bundle * @return */ @@ -252,7 +252,7 @@ public class BundleUtil { /** * Get the absolute path of the bundle with id <code>bundleId</code>. If * no such bundle is found, return null. - * + * * @param bundleId * @return */ @@ -262,12 +262,12 @@ public class BundleUtil { return null; return getResolvedBundleLocation(bundle); } - + /* * Bug 126085 - need to fix up file: protocol - * to a form that IE7 understands (file:///). + * to a form that IE7 understands (file:///). */ - + private static String toExternalForm(URL localURL) { try { localURL = FileLocator.toFileURL(localURL); diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/util/FindSupport.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/util/FindSupport.java index 8a8622e22..0de967c40 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/util/FindSupport.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/util/FindSupport.java @@ -44,21 +44,21 @@ public class FindSupport { } /** - * See doc on @link Platform#find(Bundle, IPath) Platform#find(Bundle, IPath) + * See doc on @link Platform#find(Bundle, IPath) Platform#find(Bundle, IPath) */ public static URL find(Bundle bundle, IPath path) { return find(bundle, path, null); } /** - * Proposed API for Platform in Eclispe 3.2. + * Proposed API for Platform in Eclispe 3.2. * Same as @link #find(Bundle, IPath) except multiple entries can be - * returned if more than one entry matches the path in the host and + * returned if more than one entry matches the path in the host and * any of its fragments. - * + * * @param bundle * @param path - * @return an array of entries which match the given path. An empty + * @return an array of entries which match the given path. An empty * array is returned if no matches are found. */ public static URL[] findEntries(Bundle bundle, IPath path) { @@ -69,7 +69,7 @@ public class FindSupport { * Proposed API for Platform in Eclipse 3.2. Same as @link #find(Bundle, IPath) except multiple * entries can be returned if more than one entry matches the path in the host and any of its * fragments. - * + * * @param bundle * @param path * @param override @@ -83,12 +83,12 @@ public class FindSupport { } /** - * See doc on @link Platform#find(Bundle, IPath, Map) Platform#find(Bundle, IPath, Map) + * See doc on @link Platform#find(Bundle, IPath, Map) Platform#find(Bundle, IPath, Map) */ public static URL find(Bundle b, IPath path, Map<String, String> override) { return find(b, path, override, null); } - + private static URL find(Bundle b, IPath path, Map<String, String> override, List<URL> multiple) { if (path == null) return null; @@ -99,7 +99,7 @@ public class FindSupport { if (path.isEmpty() || path.isRoot()) { // Watch for the root case. It will produce a new // URL which is only the root directory (and not the - // root of this plugin). + // root of this plugin). result = findInPlugin(b, Path.EMPTY, multiple); if (result == null || multiple != null) result = findInFragments(b, Path.EMPTY, multiple); @@ -182,7 +182,7 @@ public class FindSupport { ws = Platform.getWS(); IPath filePath = new Path("ws").append(ws).append(path); //$NON-NLS-1$ // We know that there is only one segment to the ws path - // e.g. ws/win32 + // e.g. ws/win32 URL result = findInPlugin(b, filePath, multiple); if (result != null && multiple == null) return result; @@ -252,7 +252,7 @@ public class FindSupport { } /** - * See doc on @link Platform#openStream(Bundle, IPath, boolean) Platform#Platform#openStream(Bundle, IPath, boolean) + * See doc on @link Platform#openStream(Bundle, IPath, boolean) Platform#Platform#openStream(Bundle, IPath, boolean) */ public static final InputStream openStream(Bundle bundle, IPath file, boolean localized) throws IOException { URL url = null; diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/util/ModelUtil.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/util/ModelUtil.java index d5198aa29..260422997 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/util/ModelUtil.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/util/ModelUtil.java @@ -65,7 +65,7 @@ public class ModelUtil { * yes, returns it as is. If no, treats it as a resource relative to the * declaring plugin. Return the plugin relative location, fully qualified. * Retruns null if the passed string itself is null. - * + * * @param resource * @param pluginDesc * @return returns the URL as is if it had a protocol. @@ -85,7 +85,7 @@ public class ModelUtil { * yes, returns it as is. If no, treats it as a resource relative to the * declaring plugin. Return the plugin relative location, fully qualified. * Retruns null if the passed string itself is null. - * + * * @param resource * @param pluginDesc * @return returns the URL as is if it had a protocol. @@ -138,7 +138,7 @@ public class ModelUtil { /* - * + * * ******** XHTML DOM util methods ********************************* */ @@ -226,7 +226,7 @@ public class ModelUtil { /** * Returns a reference to the body of the DOM. - * + * * @param dom * @return */ @@ -291,7 +291,7 @@ public class ModelUtil { /** * Same as getElementsByTagName(Element parent, String tagName) but the * parent element is assumed to be the root of the document. - * + * * @see getElementsByTagName(Element parent, String tagName) */ public static Element[] getElementsByTagName(Document dom, String tagName) { @@ -323,7 +323,7 @@ public class ModelUtil { */ public static Element getElementById(Document dom, String id, String localElementName) { - + NodeList children = dom.getElementsByTagNameNS("*", localElementName); //$NON-NLS-1$ for (int i = 0; i < children.getLength(); i++) { Element element = (Element) children.item(i); @@ -338,7 +338,7 @@ public class ModelUtil { public static Element getElementById(Document dom, String id) { return getElementById(dom, id, "*"); //$NON-NLS-1$ } - + public static void updateResourceAttributes(Element element, AbstractIntroPage page) { updateResourceAttributes(element, page.getBase(), page.getBundle()); @@ -354,7 +354,7 @@ public class ModelUtil { /** * Updates all the resource attributes of the passed element to point to a * local resolved url. - * + * * @param element * @param extensionContent */ @@ -424,7 +424,7 @@ public class ModelUtil { /** * Remove all instances of the element from the DOM. - * + * */ public static void removeAllElements(Document dom, String elementLocalName) { // get all elements in DOM and remove them. diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/viewer/IntroModelLabelProvider.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/viewer/IntroModelLabelProvider.java index 3e6efbad7..feec88dae 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/viewer/IntroModelLabelProvider.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/model/viewer/IntroModelLabelProvider.java @@ -123,10 +123,10 @@ public class IntroModelLabelProvider extends LabelProvider { case AbstractIntroElement.CONTAINER_EXTENSION: label = "Unresolved ConfigExtension: " //$NON-NLS-1$ + ((IntroExtensionContent) introElement).getPath(); - break; + break; case AbstractIntroElement.ANCHOR: label = "ANCHOR: " //$NON-NLS-1$ - + getPath(introElement.getParent(), ((IntroAnchor) introElement).getId()); + + getPath(introElement.getParent(), ((IntroAnchor) introElement).getId()); break; case AbstractIntroElement.PAGE_TITLE: label = "Title: " //$NON-NLS-1$ diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/parts/StandbyPart.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/parts/StandbyPart.java index 80c57d355..24a0b475a 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/parts/StandbyPart.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/parts/StandbyPart.java @@ -54,7 +54,7 @@ import org.eclipse.ui.intro.config.IStandbyContentPart; * Intro goes out of standby content mode, and the standby content parts are not * shown anymore until the user explicitly asks for a part again. This is * accomplished through a data flag on the CustomizableIntroPart control. - * + * */ public class StandbyPart implements IIntroConstants { @@ -124,7 +124,7 @@ public class StandbyPart implements IIntroConstants { /* * (non-Javadoc) - * + * * @see org.eclipse.ui.intro.IIntroPart#saveState(org.eclipse.ui.IMemento) */ private IMemento getMemento(IMemento memento, String key) { @@ -174,7 +174,7 @@ public class StandbyPart implements IIntroConstants { /** * Empty content part used as backup for failures. - * + * */ private void addAndShowEmptyPart(String message) { if (emptyPart == null) @@ -186,7 +186,7 @@ public class StandbyPart implements IIntroConstants { /** * Tries to create the last content part viewed, based on content part id.. - * + * * @param memento * @return */ @@ -204,7 +204,7 @@ public class StandbyPart implements IIntroConstants { /** * Sets the into part to standby, and shows the passed standby part, with * the given input. - * + * * @param partId * @param input */ @@ -258,7 +258,7 @@ public class StandbyPart implements IIntroConstants { * the corresponding part id. This is needed to retrive the control of a * given standby part. The IMemento should be passed to the StandbyPart when * it is initialized. - * + * * @param standbyContent */ public Control addStandbyContentPart(String partId, @@ -350,7 +350,7 @@ public class StandbyPart implements IIntroConstants { /** * Calls dispose on all cached IStandbyContentParts. - * + * */ public void dispose() { for (ControlKey controlKey : cachedContentParts.values()) { @@ -365,7 +365,7 @@ public class StandbyPart implements IIntroConstants { * subclass momento to also give the standby content part its own name * space. This was momentos saved by different content parts will not * conflict. - * + * * @param memento * the memento in which to store state information */ @@ -394,7 +394,7 @@ public class StandbyPart implements IIntroConstants { /* * Set focus on the IStandbyContentPart that corresponds to the top control * in the stack. - * + * * @see org.eclipse.ui.internal.intro.impl.parts.IStandbyContentPart#setFocus() */ public void setFocus() { @@ -410,7 +410,7 @@ public class StandbyPart implements IIntroConstants { /** * Checks the standby cache stack if we have already created a similar * IStandbyContentPart. If not, returns null. - * + * * @param standbyContent * @return */ diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/presentations/BrowserIntroPartImplementation.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/presentations/BrowserIntroPartImplementation.java index 548829a2c..970777896 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/presentations/BrowserIntroPartImplementation.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/presentations/BrowserIntroPartImplementation.java @@ -76,12 +76,12 @@ import org.w3c.dom.NodeList; public class BrowserIntroPartImplementation extends AbstractIntroPartImplementation implements IPropertyListener, IIntroContentProviderSite { - + private final class ReduceAction extends Action { { - setToolTipText(Messages.Browser_reduce_tooltip); + setToolTipText(Messages.Browser_reduce_tooltip); setImageDescriptor(ImageUtil .createImageDescriptor("full/elcl16/reduce_font.gif")); //$NON-NLS-1$ setDisabledImageDescriptor(ImageUtil @@ -101,7 +101,7 @@ public class BrowserIntroPartImplementation extends private final class MagnifyAction extends Action { { - setToolTipText(Messages.Browser_magnify_tooltip); + setToolTipText(Messages.Browser_magnify_tooltip); setImageDescriptor(ImageUtil .createImageDescriptor("full/elcl16/magnify_font.gif")); //$NON-NLS-1$ setDisabledImageDescriptor(ImageUtil @@ -120,14 +120,14 @@ public class BrowserIntroPartImplementation extends private static final int SCALE_INCREMENT = 20; - // the browser widget that will display the intro content + // the browser widget that will display the intro content protected Browser browser = null; // the HTML generator used to generate dynamic content private IntroHTMLGenerator htmlGenerator = null; - + private String savedContent = null; - + private Action openBrowserAction = new Action() { { @@ -143,19 +143,19 @@ public class BrowserIntroPartImplementation extends try { tempFile = File.createTempFile("intro",".html"); //$NON-NLS-1$//$NON-NLS-2$ tempFile.deleteOnExit(); - BufferedWriter out = new BufferedWriter(new + BufferedWriter out = new BufferedWriter(new FileWriter(tempFile)); - out.write(savedContent); + out.write(savedContent); out.close(); IWorkbenchBrowserSupport support = PlatformUI.getWorkbench().getBrowserSupport(); IWebBrowser browser = support.getExternalBrowser(); browser.openURL(tempFile.toURI().toURL()); } catch (IOException e) { } catch (PartInitException e) { - } + } } - }; - + }; + private void restartIntro() { IIntroManager manager = PlatformUI.getWorkbench().getIntroManager(); IIntroPart part = manager.getIntro(); @@ -255,7 +255,7 @@ public class BrowserIntroPartImplementation extends browser.setText(Messages.Browser_invalidConfig); return; } - + // root page is what decides if the model is dynamic or not. if (getModel().isDynamic()) handleDynamicIntro(); @@ -306,7 +306,7 @@ public class BrowserIntroPartImplementation extends * Generate dynamic HTML for the provided page, and set it in the browser * widget. A cache is used for performance and for having a correct dynamic * content life cycle. This method also updates the navigation history. - * + * * @param page * the page to generate HTML for */ @@ -385,7 +385,7 @@ public class BrowserIntroPartImplementation extends if (IntroPlugin.DEBUG_TOOLBAR) { savedContent = content; } - + } return success; } @@ -421,7 +421,7 @@ public class BrowserIntroPartImplementation extends reinjectDynamicContent(dom, contentProviderElements); return content; } - + private String generateDoctype(boolean strict) { StringWriter swriter = new StringWriter(); PrintWriter writer = new PrintWriter(swriter); @@ -431,7 +431,7 @@ public class BrowserIntroPartImplementation extends } else { writer.println("<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\""); //$NON-NLS-1$ - writer.println("\t\t\t\"http://www.w3.org/TR/html4/loose.dtd\">"); //$NON-NLS-1$ + writer.println("\t\t\t\"http://www.w3.org/TR/html4/loose.dtd\">"); //$NON-NLS-1$ } writer.close(); return swriter.toString(); @@ -509,7 +509,7 @@ public class BrowserIntroPartImplementation extends /** * Return the cached IntroHTMLGenerator - * + * * @return */ private IntroHTMLGenerator getHTMLGenerator() { @@ -538,7 +538,7 @@ public class BrowserIntroPartImplementation extends toolBarManager.add(forwardAction); toolBarManager.update(true); IntroTheme theme = getModel().getTheme(); - boolean createZoomButtons = theme != null && theme.isScalable() && !resizeActionsAdded + boolean createZoomButtons = theme != null && theme.isScalable() && !resizeActionsAdded &&FontSelection.FONT_RELATIVE.equals(FontSelection.getFontStyle()); if (createZoomButtons) { toolBarManager.add(new ReduceAction()); @@ -589,7 +589,7 @@ public class BrowserIntroPartImplementation extends /** * Handle model property changes. Property listeners are only added in the * dynamic case. - * + * * @see org.eclipse.ui.IPropertyListener#propertyChanged(java.lang.Object, * int) */ @@ -623,7 +623,7 @@ public class BrowserIntroPartImplementation extends } /** - * + * * @see org.eclipse.ui.internal.intro.impl.model.AbstractIntroPartImplementation#reflow() */ @Override diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/presentations/FormIntroPartImplementation.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/presentations/FormIntroPartImplementation.java index 44b125072..30672b61a 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/presentations/FormIntroPartImplementation.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/presentations/FormIntroPartImplementation.java @@ -148,7 +148,7 @@ public class FormIntroPartImplementation extends * holds the home page, and one that holds all other pages. If the * presentation is configured to not show the home page with the Home Page * layout, then this page book will only have one page. - * + * * @param toolkit * @param form * @return @@ -230,7 +230,7 @@ public class FormIntroPartImplementation extends * Handle model property changes. The UI is notified here of a change to the * current page in the model. This happens if an intro URL showPage method * is executed. - * + * * @see org.eclipse.ui.IPropertyListener#propertyChanged(java.lang.Object, * int) */ @@ -378,7 +378,7 @@ public class FormIntroPartImplementation extends * form from the correct pagebook that refers to the page we need to * refresh. This will force a call to createContents on all content * providers the next time this page needs to be displayed. - * + * * @see org.eclipse.ui.intro.config.IIntroContentProviderSite#reflow(org.eclipse.ui.intro.config.IIntroContentProvider, * boolean) */ @@ -392,14 +392,14 @@ public class FormIntroPartImplementation extends else if (pageFormWithNav.hasPage(page.getId())) pageFormWithNav.reflow(); else if (mainPageBook.hasPage(page.getId())) - mainPageBook.reflow(true); + mainPageBook.reflow(true); } else { removeCachedPage(page); showPage(model.getCurrentPage()); } } - + @Override public void setFocus() { if (model.isDynamic()) { diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/presentations/IntroLaunchBar.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/presentations/IntroLaunchBar.java index 29891fdb1..6dc3bab73 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/presentations/IntroLaunchBar.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/presentations/IntroLaunchBar.java @@ -3,7 +3,7 @@ * 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: IBM Corporation - initial API and implementation * Lars Vogel <Lars.Vogel@vogella.com> - Bug 440136 **************************************************************************************************/ @@ -68,10 +68,10 @@ import org.eclipse.ui.intro.config.IntroURLFactory; * This class is responsible for creating the intro launch bar in the provided parent. It creates * 'restore' and 'close' actions, as well as actions for each shortcut element contributed in the * extension point. - * + * * Reimplemented as an E4 MToolControl for 4.x. Ideally the intro configuration information would be * available from the application IEclipseContext. - * + * * @since 3.1 */ public class IntroLaunchBar { @@ -97,7 +97,7 @@ public class IntroLaunchBar { private IntroLaunchBarElement element; protected boolean simple; - + @Inject @Optional private IntroTheme theme; @@ -178,7 +178,7 @@ public class IntroLaunchBar { /** * Install the Intro Launch Bar into the provided window. - * + * * @param window * the window to host the launch bar * @param modelRoot @@ -191,7 +191,7 @@ public class IntroLaunchBar { IntroLaunchBarElement element) { EModelService modelService = (EModelService) window.getService(EModelService.class); MTrimmedWindow trimmedWindow = (MTrimmedWindow) window.getService(MTrimmedWindow.class); - + MToolControl trimControl = modelService.createModelElement(MToolControl.class); trimControl.setElementId(LAUNCHBAR_ID); trimControl.setContributionURI(BUNDLECLASS_URI); @@ -212,7 +212,7 @@ public class IntroLaunchBar { * Remove all traces of any launch bars found in the model. Required on startup as the * {@linkplain IntroLaunchBar} instances may not be have been rendered yet and so are * disconnected from the {@link IntroPlugin}'s state. - * + * * @param workbench * the workbench to process */ @@ -298,11 +298,11 @@ public class IntroLaunchBar { /** * Not supported anymore as of the removal of the presentation API * TODO remove usage, see Bug 446171 - * + * * @return */ protected boolean isPlain() { - return true; + return true; } public void createControl(Composite parent) { @@ -478,7 +478,7 @@ public class IntroLaunchBar { } } } - + private String resolveColor(String value) { if (value.indexOf('$')== -1) return value; @@ -642,7 +642,7 @@ public class IntroLaunchBar { /* * (non-Javadoc) - * + * * @see org.eclipse.ui.internal.IWindowTrim#getId() */ public String getId() { @@ -651,7 +651,7 @@ public class IntroLaunchBar { /* * (non-Javadoc) - * + * * @see org.eclipse.ui.internal.IWindowTrim#getDisplayName() */ public String getDisplayName() { @@ -660,7 +660,7 @@ public class IntroLaunchBar { /* * (non-Javadoc) - * + * * @see org.eclipse.ui.internal.IWindowTrim#isCloseable() */ public boolean isCloseable() { @@ -669,7 +669,7 @@ public class IntroLaunchBar { /* * (non-Javadoc) - * + * * @see org.eclipse.ui.internal.IWindowTrim#handleClose() */ public void handleClose() { @@ -678,7 +678,7 @@ public class IntroLaunchBar { /* * (non-Javadoc) - * + * * @see org.eclipse.ui.IWindowTrim#getWidthHint() */ public int getWidthHint() { @@ -687,7 +687,7 @@ public class IntroLaunchBar { /* * (non-Javadoc) - * + * * @see org.eclipse.ui.IWindowTrim#getHeightHint() */ public int getHeightHint() { @@ -696,7 +696,7 @@ public class IntroLaunchBar { /* * (non-Javadoc) - * + * * @see org.eclipse.ui.IWindowTrim#isResizeable() */ public boolean isResizeable() { diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/PageContentForm.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/PageContentForm.java index 6e918e1d8..838fbc9dd 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/PageContentForm.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/PageContentForm.java @@ -60,7 +60,7 @@ public class PageContentForm implements IIntroConstants { * Create the form for the root page. Number of columns there is equal to * the number of links. Every image link does not cache a model object for * data retrieval.. - * + * * @param pageBook */ public void createPartControl(ScrolledPageBook contentPageBook, @@ -113,11 +113,11 @@ public class PageContentForm implements IIntroConstants { /** * Creates a composite with TableWrapLayout to hold all page children. The * default number of columns is 1. - * + * * @param parent * @return */ - static Composite createPageTableComposite(PageWidgetFactory factory, FormToolkit toolkit, + static Composite createPageTableComposite(PageWidgetFactory factory, FormToolkit toolkit, PageStyleManager styleManager, Composite parent) { Composite client = toolkit.createComposite(parent); TableWrapLayout layout = new TableWrapLayout(); diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/PageForm.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/PageForm.java index 4f010fd0b..5d1d2b39e 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/PageForm.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/PageForm.java @@ -79,7 +79,7 @@ public class PageForm implements IIntroConstants { }; /** - * + * */ public PageForm(FormToolkit toolkit, IntroModelRoot modelRoot, Form parentForm) { @@ -90,7 +90,7 @@ public class PageForm implements IIntroConstants { /** * Create a Form for holding pages without navigation. - * + * * @param pageBook */ public void createPartControl(ScrolledPageBook mainPageBook, @@ -129,7 +129,7 @@ public class PageForm implements IIntroConstants { * This method is called when the current page changes. It creates the * PageContentForm if necessary, and handles showing the page in the Page * Book. It creates a model PageContentForm for the current page. - * + * * @param pageID */ public void showPage(AbstractIntroPage page, @@ -159,7 +159,7 @@ public class PageForm implements IIntroConstants { // a few methods like 'setFocus()' etc. // DG } - + public void reflow() { categoryPageBook.reflow(true); } diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/PageFormWithNavigation.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/PageFormWithNavigation.java index cf7dd3ea6..1b1a59ced 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/PageFormWithNavigation.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/PageFormWithNavigation.java @@ -40,7 +40,7 @@ public class PageFormWithNavigation extends PageForm { /** - * + * */ public PageFormWithNavigation(FormToolkit toolkit, IntroModelRoot modelRoot, Form parentForm) { @@ -49,7 +49,7 @@ public class PageFormWithNavigation extends PageForm { /** * Extend parent behavior and add navigation. - * + * * @param pageBook */ @Override @@ -100,7 +100,7 @@ public class PageFormWithNavigation extends PageForm { /** * Creates an Image Hyperlink from an IntroLink. Model object is NOT cached. - * + * * @param body * @param link */ diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/PageStyleManager.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/PageStyleManager.java index 8127c2ece..f34a81386 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/PageStyleManager.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/PageStyleManager.java @@ -49,14 +49,14 @@ public class PageStyleManager extends SharedStyleManager { * is retrieved from the page model class. The default properties are * assumed to be the presentation shared properties. The inherrited * properties are properties that we got from included and extension styles. - * + * * @param modelRoot */ public PageStyleManager(AbstractIntroPage page, Properties sharedProperties) { this.page = page; context = new StyleContext(); context.bundle = page.getBundle(); - + // honor shared-style. if (page.injectSharedStyle()) properties = new Properties(sharedProperties); @@ -115,7 +115,7 @@ public class PageStyleManager extends SharedStyleManager { * current pages style. If the given key is not found, the pageId is trimmed * from the begining of the key, and the key is looked up again. If key does * not start with a pageId, lookup only the key as is. - * + * * @param key * @return */ @@ -138,11 +138,11 @@ public class PageStyleManager extends SharedStyleManager { /** * Finds the context from which this key was loaded. If the key is not from * an inherited alt style, then use the context corresponding to this page. - * + * * @param key * @return */ - + @Override protected StyleContext getAssociatedContext(String key) { Properties aProperties = findPropertyOwner(key); @@ -167,7 +167,7 @@ public class PageStyleManager extends SharedStyleManager { public int getNumberOfColumns(IntroGroup group) { return getIntProperty(group, ".layout.ncolumns", 0); //$NON-NLS-1$ } - + public boolean getEqualWidth(IntroGroup group) { return getBooleanProperty(group, ".layout.equalWidth", false); //$NON-NLS-1$ } @@ -204,7 +204,7 @@ public class PageStyleManager extends SharedStyleManager { String key = buff.append(qualifier).toString(); return getIntProperty(key, defaultValue); } - + private boolean getBooleanProperty(AbstractBaseIntroElement element, String qualifier, boolean defaultValue) { StringBuffer buff = ModelLoaderUtil.createPathToElementKey(element, true); @@ -227,7 +227,7 @@ public class PageStyleManager extends SharedStyleManager { } return intValue; } - + private boolean getBooleanProperty(String key, boolean defaultValue) { boolean booleanValue = defaultValue; String value = getProperty(key); @@ -245,9 +245,9 @@ public class PageStyleManager extends SharedStyleManager { * element> * </p> * If not found, use the default description style. - * + * * Returns null if no default style found, or any id in path is null. - * + * * @param group * @return */ @@ -267,9 +267,9 @@ public class PageStyleManager extends SharedStyleManager { * <pageId>.description-id= <id of child description Text element> * </p> * If not found, use the default description style. - * + * * Returns null if no default style found, or any id in path is null. - * + * * @param group * @return */ @@ -302,7 +302,7 @@ public class PageStyleManager extends SharedStyleManager { * <pageId>.description-id= <id of child description Text element> * </p> * If not found, use the default description style. - * + * * @param group * @return */ @@ -333,7 +333,7 @@ public class PageStyleManager extends SharedStyleManager { /** * Returns the first direct child text element with the given style-id. - * + * * @return */ private String findTextFromStyleId(AbstractIntroContainer parent, @@ -355,7 +355,7 @@ public class PageStyleManager extends SharedStyleManager { /** * Util method to check model type, and filter model element out if it is of * the correct type. - * + * * @param element */ private AbstractIntroElement makeFiltered(AbstractIntroElement element) { @@ -398,7 +398,7 @@ public class PageStyleManager extends SharedStyleManager { String key = buff.append(".font.fg").toString(); //$NON-NLS-1$ return getColor(toolkit, key); } - + public Color getBackgrond(FormToolkit toolkit, AbstractBaseIntroElement element) { StringBuffer buff = ModelLoaderUtil.createPathToElementKey(element, true); if (buff == null) @@ -431,7 +431,7 @@ public class PageStyleManager extends SharedStyleManager { } return false; } - + private String getPropertyValue(AbstractIntroIdElement element, String suffix) { StringBuffer buff = ModelLoaderUtil.createPathToElementKey(element, true); if (buff != null) { @@ -461,7 +461,7 @@ public class PageStyleManager extends SharedStyleManager { /** * Retrieves an image for a link in a page. If not found, uses the page's * default link image. If still not found, uses the passed default. - * + * * @param link * @param qualifier * @return @@ -502,7 +502,7 @@ public class PageStyleManager extends SharedStyleManager { buff.append(qualifier); return buff.toString(); } - + private String createImageByIdKey(AbstractIntroPage page, IntroLink link, String qualifier) { if (link==null || link.getId()==null) diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/PageWidgetFactory.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/PageWidgetFactory.java index 68f6e12b1..c0bfde650 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/PageWidgetFactory.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/PageWidgetFactory.java @@ -174,7 +174,7 @@ public class PageWidgetFactory { c = createSeparator(parent, sep); updateLayoutData(c, element); break; - + default: break; } @@ -238,7 +238,7 @@ public class PageWidgetFactory { /** * Creates an Image Hyperlink from an IntroLink. Model object is NOT cached. - * + * * @param body * @param link */ @@ -306,7 +306,7 @@ public class PageWidgetFactory { /** * Creates a forms Text or FormattedText. - * + * * @param body * @param link */ @@ -366,7 +366,7 @@ public class PageWidgetFactory { } return ilabel; } - + public Control createContentProvider(Composite parent, IntroContentProvider provider) { // If we've already loaded the content provider for this element, @@ -411,7 +411,7 @@ public class PageWidgetFactory { } return container; } - + protected Control createSeparator(Composite parent, IntroSeparator sep) { String key = sep.getParentPage().getId()+".separator.fg"; //$NON-NLS-1$ Color fg = styleManager.getColor(toolkit, key); @@ -462,7 +462,7 @@ public class PageWidgetFactory { /** * Will be only called for non formatted text. - * + * * @param text * @return */ @@ -481,7 +481,7 @@ public class PageWidgetFactory { /** * Check the filter state of the element. Only base elements have the filter * attribute. - * + * * @param element * @return */ diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/RootPageForm.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/RootPageForm.java index 49153242c..18f01b636 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/RootPageForm.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/RootPageForm.java @@ -155,7 +155,7 @@ public class RootPageForm implements IIntroConstants { }; /** - * + * */ public RootPageForm(FormToolkit toolkit, IntroModelRoot modelRoot, Form parentForm) { @@ -167,7 +167,7 @@ public class RootPageForm implements IIntroConstants { /** * Create the form for the root page. Number of columns there is equal to * the number of links. - * + * * @param pageBook */ public void createPartControl(ScrolledPageBook mainPageBook, @@ -277,7 +277,7 @@ public class RootPageForm implements IIntroConstants { /** * Creates an Image Hyperlink from an IntroLink. Model object is cached in * link. - * + * * @param body * @param link */ @@ -318,7 +318,7 @@ public class RootPageForm implements IIntroConstants { /** * Creates a label to display the link description when you hover over a * hyperlink. - * + * * @param body */ private Label createHoverLabel(Composite body) { @@ -333,7 +333,7 @@ public class RootPageForm implements IIntroConstants { label.setFont(PageStyleManager.getBannerFont()); return label; } - + private void createContentProvider(Composite parent, IntroContentProvider providerElement) { if (factory==null) { factory = new PageWidgetFactory(toolkit, rootPageStyleManager); diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/SharedStyleManager.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/SharedStyleManager.java index 8bb40f13e..9a425518a 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/SharedStyleManager.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/swt/SharedStyleManager.java @@ -30,7 +30,7 @@ public class SharedStyleManager { protected Properties properties; protected StyleContext context; - + class StyleContext { IPath path; Bundle bundle; @@ -44,7 +44,7 @@ public class SharedStyleManager { /** * Constructor used when shared styles need to be loaded. The bundle is * retrieved from the model root. - * + * * @param modelRoot */ public SharedStyleManager(IntroModelRoot modelRoot) { @@ -67,7 +67,7 @@ public class SharedStyleManager { InputStream is = styleURL.openStream(); properties.load(is); is.close(); - context.path = new Path(style).removeLastSegments(1); + context.path = new Path(style).removeLastSegments(1); String t = (String)properties.get("theme"); //$NON-NLS-1$ if (t!=null && t.trim().equalsIgnoreCase("true")) //$NON-NLS-1$ context.inTheme = true; @@ -79,7 +79,7 @@ public class SharedStyleManager { /** * Get the property from the shared properties. - * + * * @param key * @return */ @@ -110,7 +110,7 @@ public class SharedStyleManager { * A utility method that creates RGB object from a value encoded in the * following format: #rrggbb, where r, g and b are hex color values in the * range from 00 to ff. - * + * * @param value * @return */ @@ -135,14 +135,14 @@ public class SharedStyleManager { /** * Finds the bundle from which this key was loaded. This is the bundle from * which shared styles where loaded. - * + * * @param key * @return */ protected Bundle getAssociatedBundle(String key) { return context.bundle; } - + protected StyleContext getAssociatedContext(String key) { return context; } @@ -158,8 +158,8 @@ public class SharedStyleManager { /** - * - * + * + * * @param toolkit * @param key * @return color. May return null. @@ -179,7 +179,7 @@ public class SharedStyleManager { /** * Retrieve an image from this page's properties, given a key. - * + * * @param key * @param defaultPageKey * @param defaultKey @@ -200,7 +200,7 @@ public class SharedStyleManager { if (ccontext.inTheme) { // if 'theme' key is set, load image // relative to the file, not relative to the bundle - ImageUtil.registerImage(currentKey, ccontext.path, value); + ImageUtil.registerImage(currentKey, ccontext.path, value); } else { Bundle bundle = ccontext.bundle; diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/ImageUtil.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/ImageUtil.java index 169befaa3..30f628ce0 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/ImageUtil.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/ImageUtil.java @@ -48,7 +48,7 @@ public final class ImageUtil { public static final String INTRO_MODEL_LEAF = "leaf"; //$NON-NLS-1$ public static final String INTRO_MODEL_CONTAINER = "container"; //$NON-NLS-1$ public static final String OPEN_ITNRO_VIEW = "introView"; //$NON-NLS-1$ - + public static final String CONFIG_EXTENSION = "configExtension";//$NON-NLS-1$ // Image location @@ -56,7 +56,7 @@ public final class ImageUtil { /** * Convenience method to create an image descriptor from the Intro plugin. - * + * * Method assumes that images are under the "icons" directory, so don't * append that directory name for "imageName". */ @@ -64,10 +64,10 @@ public final class ImageUtil { return createImageDescriptor(Platform .getBundle(IIntroConstants.PLUGIN_ID), ICONS_PATH + imageName); } - + /** * Convenience method to create an image descriptor. - * + * */ public static ImageDescriptor createImageDescriptor(Bundle bundle, String imageName) { @@ -85,10 +85,10 @@ public final class ImageUtil { + " in bundle: " + bundle.getSymbolicName()); //$NON-NLS-1$ return ImageDescriptor.getMissingImageDescriptor(); } - + /** * Convenience method to create an image descriptor. - * + * */ public static ImageDescriptor createImageDescriptor(IPath base, String imageName) { @@ -108,7 +108,7 @@ public final class ImageUtil { /** * Convenience method to create an image from the Intro plugin. - * + * * Method assumes that images are under the "icons" directory, so don't * append that directory name for "imageName". */ @@ -125,7 +125,7 @@ public final class ImageUtil { /** * Util method for image re-use in Intro Plugin. - * + * * @param key * @return */ @@ -145,7 +145,7 @@ public final class ImageUtil { /** * Register an image descriptor in the Intro Plugin image registry. Has no * effect if the key has already been registered. - * + * * @param key * @param imageName */ @@ -165,7 +165,7 @@ public final class ImageUtil { return; registry.put(key, createImageDescriptor(bundle, imageName)); } - + public static void registerImage(String key, IPath base, String imageName) { ImageRegistry registry = IntroPlugin.getDefault().getVolatileImageRegistry(); if (registry.getDescriptor(key) != null) diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/IntroEvaluationContext.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/IntroEvaluationContext.java index 5dfeaeec1..b6b5ea341 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/IntroEvaluationContext.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/IntroEvaluationContext.java @@ -22,9 +22,9 @@ public final class IntroEvaluationContext { private static final String VARIABLE_PLATFORM = "platform"; //$NON-NLS-1$ private static final String VARIABLE_WORKBENCH = "workbench"; //$NON-NLS-1$ - + private static EvaluationContext context; - + /* * Returns the evaluation context to use in intro documents. */ @@ -36,7 +36,7 @@ public final class IntroEvaluationContext { } return context; } - + /* * Not meant to be instantiated. */ diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/IntroModelSerializer.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/IntroModelSerializer.java index f9a51dba7..9db69684a 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/IntroModelSerializer.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/IntroModelSerializer.java @@ -42,7 +42,7 @@ public class IntroModelSerializer { public IntroModelSerializer(IntroModelRoot root) { this(root, false); } - + public IntroModelSerializer(IntroModelRoot root, boolean filter) { this.buffer = new StringBuffer(); this.filter = filter; @@ -73,7 +73,7 @@ public class IntroModelSerializer { } return url; } - + private void printModelRootInfo(IntroModelRoot model, StringBuffer text) { text.append("\nIntro Model Content:"); //$NON-NLS-1$ text.append("\n======================"); //$NON-NLS-1$ @@ -224,7 +224,7 @@ public class IntroModelSerializer { text.append(indent + "alt = " + image.getAlt()); //$NON-NLS-1$ text.append(indent + "style-id = " + image.getStyleId()); //$NON-NLS-1$ } - + private void printSeparator(StringBuffer text, IntroSeparator sep, String indent) { text.append(indent + "HR: id = " + sep.getId()); //$NON-NLS-1$ indent = indent + "\t\t"; //$NON-NLS-1$ @@ -282,7 +282,7 @@ public class IntroModelSerializer { /** * Appends a given page's categories to the Text buffer. - * + * * @param text */ private void printPages(IntroPage[] pages, StringBuffer text) { diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/Log.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/Log.java index f7754c447..4a32fffcc 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/Log.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/Log.java @@ -25,7 +25,7 @@ import org.eclipse.ui.internal.intro.impl.IntroPlugin; * mode. Info messages are only logged when the /trace/logInfo debug option is * set to true. Performance reports are only logged when /trace/performance is * set to true. - * + * */ public class Log implements IIntroConstants { diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/ReopenUtil.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/ReopenUtil.java index f99665a51..1bdd587fb 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/ReopenUtil.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/ReopenUtil.java @@ -25,33 +25,33 @@ import org.eclipse.ui.XMLMemento; import org.eclipse.ui.internal.intro.impl.IntroPlugin; /** - * Utility class which manages the pseudo preference which determines whether + * Utility class which manages the pseudo preference which determines whether * Intro should always open on startup */ public class ReopenUtil { - + private static final String STATE = "state"; //$NON-NLS-1$ private static final String REOPEN = "reopen"; //$NON-NLS-1$ public static boolean isReopenPreferenceInitialized() { return readMemento() != null; } - + public static void setReopenPreference(boolean reopen) { - XMLMemento memento = XMLMemento.createWriteRoot(STATE); - memento.putBoolean(REOPEN, reopen); + XMLMemento memento = XMLMemento.createWriteRoot(STATE); + memento.putBoolean(REOPEN, reopen); saveMemento(memento); } - + public static boolean isReopenPreference() { XMLMemento memento = readMemento(); if (memento == null) { return false; } - return memento.getBoolean(REOPEN).booleanValue(); + return memento.getBoolean(REOPEN).booleanValue(); } - + private static XMLMemento readMemento() { XMLMemento memento; InputStreamReader reader = null; @@ -64,7 +64,7 @@ public class ReopenUtil { reader = new InputStreamReader(input, StandardCharsets.UTF_8); memento = XMLMemento.createReadRoot(reader); - + } catch (FileNotFoundException e) { memento = null; // Do nothing, the file will not exist the first time the workbench in used. @@ -96,7 +96,7 @@ public class ReopenUtil { if (writer != null) writer.close(); } catch (IOException e) { - + } } } diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/StringUtil.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/StringUtil.java index b1add5d19..e0e0d27ba 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/StringUtil.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/StringUtil.java @@ -69,16 +69,16 @@ public class StringUtil { public static String decode(String s, String enc) throws UnsupportedEncodingException { try { return URLDecoder.decode(s, enc); - } + } catch (Exception ex) { // fall back to original string return s; } } - + // Removes leading and trailing whitespace and replaces other - // occurrences with a single space. - + // occurrences with a single space. + public static String normalizeWhiteSpace(String input) { if (input == null) { return null; diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/Util.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/Util.java index 09093455f..d93f3a194 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/Util.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/util/Util.java @@ -72,7 +72,7 @@ public class Util { /** * Utility method that will add a debug listener to the given control. All * common events are added. - * + * * @param control * @return */ diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/CustomizableIntroPart.java b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/CustomizableIntroPart.java index 1a07faeca..aac305360 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/CustomizableIntroPart.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/CustomizableIntroPart.java @@ -62,12 +62,12 @@ import org.eclipse.ui.part.IntroPart; * creation on load, and leaves restoring state to content part. Same with * saving state. The memento is passed shortly before shutdown to enable storing * of part specific data. - * + * * Note: This class was made public for re-use, as-is, as a valid class for the * <code>org.eclipse.ui.intro</code> extension point. It is not intended to be * subclassed or used otherwise. * </p> - * + * * @since 3.0 */ @@ -155,7 +155,7 @@ public final class CustomizableIntroPart extends IntroPart implements boolean startAtHomePage = ReopenUtil.isReopenPreference(); if (startAtHomePage) { PlatformUI.getPreferenceStore().setValue( - IWorkbenchPreferenceConstants.SHOW_INTRO, true); + IWorkbenchPreferenceConstants.SHOW_INTRO, true); memento = null; } // we have a valid config contribution, get presentation. Make sure @@ -186,7 +186,7 @@ public final class CustomizableIntroPart extends IntroPart implements /** * Creates the UI based on how the InroPart has been configured. - * + * * @see org.eclipse.ui.IWorkbenchPart#createPartControl(org.eclipse.swt.widgets.Composite) */ @Override @@ -217,7 +217,7 @@ public final class CustomizableIntroPart extends IntroPart implements * Determine if we need to recreate a standby part. Return true if we have a * standby part memento that is not for the empty part AND stangby memento * has been tagged for restore, ie: it was open when workbench closed. - * + * * @param memento * @return <code>true</code> if we need to recreate a standby part */ @@ -242,7 +242,7 @@ public final class CustomizableIntroPart extends IntroPart implements /* * Handled state changes. Recreates the standby part if workbench was shut * down with one. - * + * * @see org.eclipse.ui.IIntroPart#standbyStateChanged(boolean) */ @Override @@ -282,7 +282,7 @@ public final class CustomizableIntroPart extends IntroPart implements * cases. This basically overrides the workbench behavior of Standby/normal * states. The design here is that if the showStandbyPart flag is set, then * we always need to show the standby part. - * + * * @return <code>true</code> if we need to show the standby part */ private boolean isStandbyPartNeeded() { @@ -368,7 +368,7 @@ public final class CustomizableIntroPart extends IntroPart implements /** * Returns the primary control associated with this Intro part. - * + * * @return the SWT control which displays this Intro part's content, or * <code>null</code> if this standby part's controls have not yet * been created. @@ -413,7 +413,7 @@ public final class CustomizableIntroPart extends IntroPart implements /** * Support dynamic awarness. - * + * * @see org.eclipse.core.runtime.IRegistryChangeListener#registryChanged(org.eclipse.core.runtime.IRegistryChangeEvent) */ @Override diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IIntroAction.java b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IIntroAction.java index 20eed684c..4729aa6b6 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IIntroAction.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IIntroAction.java @@ -21,7 +21,7 @@ import org.eclipse.ui.intro.IIntroSite; * <p> * http://org.eclipse.ui.intro/runAction?pluginId=x.y.z&class=x.y.z.someClass * </p> - * + * * @since 3.0 */ public interface IIntroAction { @@ -29,7 +29,7 @@ public interface IIntroAction { /** * Called to run this intro command. The properties represents the key=value * pairs extracted from the intro URL query. - * + * * @param site * @param params */ diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IIntroContentProvider.java b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IIntroContentProvider.java index 507e3ff50..aef621e1f 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IIntroContentProvider.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IIntroContentProvider.java @@ -25,14 +25,14 @@ import org.eclipse.ui.forms.widgets.FormToolkit; * <ul> * <li>a content provider is defined in the Intro content markup file (ie: * introContent.xml file) as follows: - * + * * <p> * <contentProvider id="roles" * class="x.y.z.ContentProvider"> <br> * <text>Some alternate text for dynamic content</text> <br> * </contentProvider> * </p> - * + * * This defines the content provider as part of the intro content for that page. * </li> * <li>the content provider class is created when the page that contains this @@ -58,7 +58,7 @@ import org.eclipse.ui.forms.widgets.FormToolkit; * when the appropriate event happens. * <li>finally, when the intro view is closed, dispose will be called on the * content provider to give it a chance to dispose of any resources.</li> - * + * * @since 3.0.1 */ public interface IIntroContentProvider { @@ -66,7 +66,7 @@ public interface IIntroContentProvider { * Initializes the content provider. An IIntroContentProviderSite is passed, * which will be called on to recompute or layout the content when the * content becomes stale. - * + * * @param site * the site of this IIntroContentProvider */ @@ -77,7 +77,7 @@ public interface IIntroContentProvider { * Creates HTML content in the provided PrintWriter. This content will be * included in the generated HTML page when embedded HTML widget is used to * render intro content. - * + * * @param id * the unique identifier of the content element. The same content * provider class can be reused for several elements and the id @@ -90,7 +90,7 @@ public interface IIntroContentProvider { /** * Creates SWT content in the provided Composite. This method is called when * Eclipse Forms are used to render intro content. - * + * * @param id * the unique identifier of the content element * @param parent diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IIntroContentProviderSite.java b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IIntroContentProviderSite.java index 3a5326e5b..833ece439 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IIntroContentProviderSite.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IIntroContentProviderSite.java @@ -19,7 +19,7 @@ package org.eclipse.ui.intro.config; * reflow. * <p> * This interface is not intended to be implemented or extended by clients. - * + * * @since 3.0.1 * @noimplement This interface is not intended to be implemented by clients. * @noextend This interface is not intended to be extended by clients. @@ -30,7 +30,7 @@ public interface IIntroContentProviderSite { * that its content has become stale. For an HTML presentation, the whole * page should be regenerated. An SWT presentation should cause the page's * layout to be updated. - * + * * @param provider * the content provider that requests a reflow * @param incremental diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IIntroURL.java b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IIntroURL.java index e4677a7c4..84d1fb917 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IIntroURL.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IIntroURL.java @@ -33,7 +33,7 @@ package org.eclipse.ui.intro.config; * There is a number of supported Intro commands. Check docs for more details. * Calling execute runs the command if it is one of the supported commands. * </p> - * + * * @see IntroURLFactory * @see IIntroAction * @since 3.0 @@ -45,7 +45,7 @@ public interface IIntroURL { /** * Executes whatever valid Intro command is embedded in this Intro URL. * Returns true if action succeeded, and false otherwise. - * + * */ public boolean execute(); @@ -57,7 +57,7 @@ public interface IIntroURL { /** * Return a parameter defined in the Intro URL. Returns null if the * parameter is not defined. - * + * * @param parameterId * the id of the parameter being requested * @return the value of the parameter, or <code>null</code> if the diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IIntroXHTMLContentProvider.java b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IIntroXHTMLContentProvider.java index 6bfe745e7..343469ef8 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IIntroXHTMLContentProvider.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IIntroXHTMLContentProvider.java @@ -16,7 +16,7 @@ import org.w3c.dom.Element; * A content provider for dynamic XHTML Intro content. When an XHTML intro page * is parsed and a contentProvider element is detected, it is used to create * dynamic XHTML content in the page. - * + * * @since 3.1 */ public interface IIntroXHTMLContentProvider extends IIntroContentProvider { @@ -24,29 +24,29 @@ public interface IIntroXHTMLContentProvider extends IIntroContentProvider { /** * Create XHTML content in the provided parent DOM Element. A typical usage * for this method would be: <br> - * + * * <br> * <code> * <contentProvider id="contentProviderId" * class="xx.yy.IntroContentProvider" * pluginId="xx.yy.id"/> <br></code> <br> - * + * * A parent DOM Element will be passed to allow for adding dynamic content * by manipulating the Java XML DOM for the XHTML file. A div is created * with an id equal to the id specified in the contentProvider element, and * is passed as the parent. In the above example, the DOM element * representing a div with id=myContentProviderDivId would be the parent * passed. - * + * * @param id * the unique identifier of the content element. The same content * provider class can be reused for several elements and the id * can be used to tell them apart. - * + * * @param parent * the parent xml Element where dynamic content will be added as * children. - * + * */ public void createContent(String id, Element parent); diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IStandbyContentPart.java b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IStandbyContentPart.java index 2a7431478..717a71d00 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IStandbyContentPart.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IStandbyContentPart.java @@ -28,17 +28,17 @@ import org.eclipse.ui.intro.IIntroPart; * pluginId="com.x.y.somePluginId" * class="com.x.y.someClass" * id="com.x.y.someContentPartId"> - * </standbyPart> + * </standbyPart> * </extension> * </pre> - * + * * </p> * Standby content parts have a life cycle that starts with a call to init, * shortly after part construction, followed by a call to createPartControl. * During these two calls, the part is responsible for creating its content and * using the memento to try to recreate its previous state. SetInput is the last * method called when trying to create a standby part. - * + * * @since 3.0 */ public interface IStandbyContentPart { @@ -48,7 +48,7 @@ public interface IStandbyContentPart { * <p> * Clients should not call this method. The intro framework calls this * method when it needs to. - * + * * @param parent * the parent control * @param toolkit @@ -60,7 +60,7 @@ public interface IStandbyContentPart { * Returns the primary control associated with this standby part. The * control is typically set during the createPartControl() call when this * part is being created. - * + * * @return the SWT control which displays this standby part's content, or * <code>null</code> if this standby part's controls have not yet * been created. @@ -77,7 +77,7 @@ public interface IStandbyContentPart { * construction. It marks the start of this parts' lifecycle. Clients must * not call this method. * </p> - * + * * @param introPart * the intro part hosting this stanndby content part. * @param memento @@ -95,7 +95,7 @@ public interface IStandbyContentPart { * an input specified, or when this standby part is being recreated from a * previous workbench session. In this case, the standby part is responsible * for handling a null input, and recreating itself from a cached IMemento. - * + * * @param input * the input object to be used by this standby part. */ @@ -125,7 +125,7 @@ public interface IStandbyContentPart { * This method is automatically called by the workbench at appropriate * times. Clients must not call this method directly. * </p> - * + * * @param memento * a memento to receive the object state */ diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IntroConfigurer.java b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IntroConfigurer.java index 3e80f94ce..5d7dc2767 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IntroConfigurer.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IntroConfigurer.java @@ -3,7 +3,7 @@ * 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: IBM Corporation - initial API and implementation **************************************************************************************************/ @@ -20,7 +20,7 @@ import org.eclipse.ui.intro.IIntroSite; * Since it is possible for multiple products to use the same intro configuration, this class allows * them to customize some aspects of the intro content so that it looks different for different * products even though they all share the same intro implementation and content. - * + * * @since 3.2 */ @@ -28,7 +28,7 @@ public abstract class IntroConfigurer { /** * The identifier of the named group where the configurer can contribute local tool bar actions. - * + * * @see #init(IIntroSite, Map) */ public static final String TB_ADDITIONS = "additions"; //$NON-NLS-1$ @@ -41,7 +41,7 @@ public abstract class IntroConfigurer { /** * Provides the opportunity for the configurer to contribute to the action bars and to fetch * presentation theme properties. - * + * * @param site * the intro part's site * @param themeProperties @@ -57,7 +57,7 @@ public abstract class IntroConfigurer { /** * Internal method to associate the corresponding intro configuration model. May be called * independently of {@link #init(IIntroSite, Map)}. - * + * * @noreference */ final public void bind(IntroModelRoot model) { @@ -71,7 +71,7 @@ public abstract class IntroConfigurer { /** * Returns the value of the theme property with a given name. - * + * * @param name * the theme property name * @return the value of the property or <code>null</code> if property is not found, the theme @@ -92,7 +92,7 @@ public abstract class IntroConfigurer { * content files in attribute names and values of elements. Whenever $variable$ is encountered * in the content, it is evaluated using this class by passing 'variable' to this method and * substituting the result in the content. - * + * * @param variableName * the name of the substitution variable * @return the value to substitute in place of a variable or <code>null</code> if the variable @@ -103,7 +103,7 @@ public abstract class IntroConfigurer { /** * Returns the children of computed groups. Groups marked as computed will be completed at run * time when the group is asked to provide children. - * + * * @param pageId * the identifier of the page in which this group appears * @param groupId @@ -117,7 +117,7 @@ public abstract class IntroConfigurer { /** * Returns an array of elements that will be used to build launch bar short cut links. Override * this method if the intro launch bar has been marked as computed. - * + * * @return an array of elements that will be used to dynamically build shortcut links. */ public IntroElement[] getLaunchBarShortcuts() { @@ -128,7 +128,7 @@ public abstract class IntroConfigurer { * Resolves an incomplete path in the form "page_id/@" where page_id represents the identifier * of the target page. The configurator should complete the path according to its internal * resolution mechanism. The final path must point at an anchor in the referenced page. - * + * * @param extensionId * the id specified for the config extension * @param path @@ -141,7 +141,7 @@ public abstract class IntroConfigurer { /** * Returns the style value that will be mixed in with the original style of the extension. * Themes can use this feature to render certain extensions differently. - * + * * @param pageId * the identifier of the target page that this extension is contributed into * @param extensionId @@ -155,7 +155,7 @@ public abstract class IntroConfigurer { /** * Return true if {@code pageId} is the configured start page. - * + * * @param pageId * the page identifier * @since 3.5 diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IntroElement.java b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IntroElement.java index feee0b531..b529c8f6a 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IntroElement.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IntroElement.java @@ -4,7 +4,7 @@ * 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: IBM Corporation - initial API and implementation **************************************************************************************************/ @@ -20,7 +20,7 @@ import java.util.List; * instances of this class from <code>IntroConfigurer</code> to dynamically complete the intro * content. Attribute and element names, as well as content model must match the intro * schema. - * + * * @since 3.2 */ public class IntroElement { @@ -32,7 +32,7 @@ public class IntroElement { /** * Creates a new intro element with the provided name. - * + * * @param name * the name of the new intro element */ @@ -42,7 +42,7 @@ public class IntroElement { /** * Sets the value of the named attribute. - * + * * @param name * attribute name * @param value @@ -54,7 +54,7 @@ public class IntroElement { /** * Returns the value of the attribute with a given name. - * + * * @param name * the attribute name * @return value of the attribute with a given name or <code>null</code> if not set. @@ -65,7 +65,7 @@ public class IntroElement { /** * Returns the names of all the attributes defined in this element. - * + * * @return an enumeration of all the element names */ @@ -75,7 +75,7 @@ public class IntroElement { /** * Returns the name of the element. - * + * * @return name of the element */ public String getName() { @@ -84,7 +84,7 @@ public class IntroElement { /** * Returns the value of the element. - * + * * @return value of the element or <code>null</code> if not set. */ public String getValue() { @@ -93,7 +93,7 @@ public class IntroElement { /** * Sets the value of the element. - * + * * @param value * the value of this element */ @@ -103,7 +103,7 @@ public class IntroElement { /** * Adds a child to this element. - * + * * @param child * the new child of this element */ @@ -115,7 +115,7 @@ public class IntroElement { /** * Returns the children of this element. - * + * * @return an array of child elements or an empty array of there are no children. */ public IntroElement[] getChildren() { @@ -123,7 +123,7 @@ public class IntroElement { return new IntroElement[0]; return (IntroElement[]) children.toArray(new IntroElement[children.size()]); } - + @Override public boolean equals(Object obj) { if (obj instanceof IntroElement) { diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IntroURLFactory.java b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IntroURLFactory.java index 1d0778cb9..f91fcaf95 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IntroURLFactory.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IntroURLFactory.java @@ -22,7 +22,7 @@ import org.eclipse.ui.internal.intro.impl.model.url.IntroURLParser; * This class provides all its functionality via static members. It is not * intended to be instantiated. * </p> - * + * * @see IIntroURL * @since 3.0 */ @@ -39,7 +39,7 @@ public final class IntroURLFactory { /** * Parses the given string, and returns an IntroURL if the string is a valid * Intro URL. Returns null in all other cases. Example usage: - * + * * <pre> * StringBuffer url = new StringBuffer(); * url.append("http://org.eclipse.ui.intro/showStandby?"); @@ -54,7 +54,7 @@ public final class IntroURLFactory { * introURL.execute(); * } * </pre> - * + * * @param url * the url to construct an IntroURL from * @return an IntroURL, or <code>null</code> if the url is invalid diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/contentproviders/AlwaysWelcomeCheckbox.java b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/contentproviders/AlwaysWelcomeCheckbox.java index 37d9bee62..dcba09ff5 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/contentproviders/AlwaysWelcomeCheckbox.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/contentproviders/AlwaysWelcomeCheckbox.java @@ -32,43 +32,43 @@ import org.eclipse.ui.intro.config.IIntroContentProviderSite; import org.eclipse.ui.PlatformUI; /** * - * Class which contributes a checkbox to an intro page which allows welcome to show - * on startup. If the checkbox is checked the home page of intro will be shown the next - * time the Eclipse application starts up. This class may be subclassed to override + * Class which contributes a checkbox to an intro page which allows welcome to show + * on startup. If the checkbox is checked the home page of intro will be shown the next + * time the Eclipse application starts up. This class may be subclassed to override * the text for the checkbox label. - * + * * Implements the IIntroContentProvider to create the checkbox ui, and the * org.eclipse.ui.intro.config.IIntroAction interface for handling checkbox click events. - * + * * @since 3.3 */ public class AlwaysWelcomeCheckbox implements IIntroContentProvider,IIntroAction { public final static String ALWAYS_SHOW_INTRO = "alwaysShowIntro"; //$NON-NLS-1$ - + private boolean disposed = false; - + /** * Override this method to change the default text used for the checkbox - * - * @return String label for the checkbox - * + * + * @return String label for the checkbox + * * @since 3.3 - * + * */ protected String getText() { // Default text return Messages.AlwaysWelcomeCheckbox_Text; } - + @Override public void createContent(String id, PrintWriter out) { boolean alwaysShowIntro = getAlwaysShowIntroPref(); - // Use an IIntroAction url that points back to this class - + // Use an IIntroAction url that points back to this class - // particularly invoking run(). // This url is 'activated' using the onClick event. out.print("<div id=\""+id+"\"><input type=\"checkbox\" "+ //$NON-NLS-1$//$NON-NLS-2$ @@ -76,15 +76,15 @@ public class AlwaysWelcomeCheckbox implements IIntroContentProvider,IIntroAction "\"http://org.eclipse.ui.intro/runAction?"+ //$NON-NLS-1$ "pluginId=org.eclipse.ui.intro&"+ //$NON-NLS-1$ "class="+this.getClass().getName()+"\" "); //$NON-NLS-1$ //$NON-NLS-2$ - + if (alwaysShowIntro) { out.print(" checked=\"checked\""); //$NON-NLS-1$ - + PlatformUI.getPreferenceStore().setValue( - IWorkbenchPreferenceConstants.SHOW_INTRO, alwaysShowIntro); + IWorkbenchPreferenceConstants.SHOW_INTRO, alwaysShowIntro); } - + out.println("/>"+getText()+"</div>"); //$NON-NLS-1$//$NON-NLS-2$ } @@ -98,7 +98,7 @@ public class AlwaysWelcomeCheckbox implements IIntroContentProvider,IIntroAction Button checkBox = new Button(parent,SWT.CHECK); toolkit.adapt((Control)checkBox,false,false); - + checkBox.setText(getText()); checkBox.setSelection(alwaysShowIntro); checkBox.addSelectionListener(new SelectionAdapter(){ @@ -107,7 +107,7 @@ public class AlwaysWelcomeCheckbox implements IIntroContentProvider,IIntroAction reverseShowIntroState(); } }); - + if (alwaysShowIntro) PlatformUI.getPreferenceStore().setValue( IWorkbenchPreferenceConstants.SHOW_INTRO, alwaysShowIntro); @@ -130,26 +130,26 @@ public class AlwaysWelcomeCheckbox implements IIntroContentProvider,IIntroAction public void run(IIntroSite site, Properties params) { reverseShowIntroState(); } - + /** * Method reverses preference ALWAYS_SHOW_INTRO due to checkbox selection change - * + * */ private void reverseShowIntroState() { // Retrieve current state of IUniversalIntroConst.ALWAYS_SHOW_INTRO, change it, and save it back // to both ALWAYS_SHOW_INTRO and SHOW_INTRO boolean alwaysShowIntro = !getAlwaysShowIntroPref(); - + // local preference store setAlwaysShowIntroPref(alwaysShowIntro); - + // workbench preference store PlatformUI.getPreferenceStore().setValue( - IWorkbenchPreferenceConstants.SHOW_INTRO, alwaysShowIntro); + IWorkbenchPreferenceConstants.SHOW_INTRO, alwaysShowIntro); } - + public boolean getAlwaysShowIntroPref() { // If uninitialized, we will default to true (box will be checked) @@ -158,7 +158,7 @@ public class AlwaysWelcomeCheckbox implements IIntroContentProvider,IIntroAction } return ReopenUtil.isReopenPreference(); } - + public void setAlwaysShowIntroPref(boolean val) { ReopenUtil.setReopenPreference(val); diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/contentproviders/EclipseRSSViewer.java b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/contentproviders/EclipseRSSViewer.java index eaf63147e..8975fa61c 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/contentproviders/EclipseRSSViewer.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/contentproviders/EclipseRSSViewer.java @@ -63,18 +63,18 @@ import org.xml.sax.helpers.DefaultHandler; * The id for the contentProvider tag must consist of the following attributes. Each of these attributes must be separated by '##'. * <ul> * <TABLE CELLPADDING=6 FRAME=BOX> - * + * * <THEAD> * <TR> <TH>Attribute</TH> <TH>Description</TH> </TR> * </THEAD> - * + * * <TBODY> * <TR> <TD>url</TD> <TD>RSS news feed url</TD> </TR> * <TR> <TD>welcome_items</TD> <TD>Number of news feed to be displayed</TD> </TR> * <TR> <TD>no_news_url</TD> <TD>Alternative url for news feed</TD> </TR> * <TR> <TD>no_news_text</TD> <TD>Text for the alternative url</TD> </TR> * </TBODY> - * + * * </TABLE> * </ul> * For example: @@ -87,7 +87,7 @@ import org.xml.sax.helpers.DefaultHandler; * </ul> * </contentProvider> * </p> - * + * * @since 3.4 */ @@ -122,7 +122,7 @@ public class EclipseRSSViewer implements IIntroContentProvider { /** * Initialize the content provider * @param site an object which allows rcontainer reflows to be requested - */ + */ @Override public void init(IIntroContentProviderSite site) { this.site = site; @@ -135,16 +135,16 @@ public class EclipseRSSViewer implements IIntroContentProvider { * @param out a writer where the html will be written */ @Override - public void createContent(String id, PrintWriter out) { + public void createContent(String id, PrintWriter out) { if (disposed) return; this.id = id; params = setParams(id); - + if (items==null) createNewsItems(); - + if (items == null || threadRunning) { out.print("<p class=\"status-text\">"); //$NON-NLS-1$ out.print(Messages.RSS_Loading); @@ -200,7 +200,7 @@ public class EclipseRSSViewer implements IIntroContentProvider { return; this.id = id; params = setParams(id); - + if (formText == null) { // a one-time pass formText = toolkit.createFormText(parent, true); @@ -222,11 +222,11 @@ public class EclipseRSSViewer implements IIntroContentProvider { StringBuffer buffer = new StringBuffer(); buffer.append("<form>"); //$NON-NLS-1$ - - + + if (items==null) createNewsItems(); - + if (items == null || threadRunning) { buffer.append("<p>"); //$NON-NLS-1$ buffer.append(Messages.RSS_Loading); @@ -255,19 +255,19 @@ public class EclipseRSSViewer implements IIntroContentProvider { } buffer.append("</form>"); //$NON-NLS-1$ - + String text = buffer.toString(); text = text.replaceAll("&{1}", "&"); //$NON-NLS-1$ //$NON-NLS-2$ formText.setText(text, true, false); } - + private String createExternalURL(String url) { try { return INTRO_SHOW_IN_BROWSER + URLEncoder.encode(url, "UTF-8"); //$NON-NLS-1$ } catch (UnsupportedEncodingException e) { return INTRO_SHOW_IN_BROWSER + url; - } + } } @Override @@ -281,28 +281,28 @@ public class EclipseRSSViewer implements IIntroContentProvider { /** * Method is responsible for gathering RSS data. - * + * * Kicks off 2 threads: - * + * * The first (ContentThread) is to actually query the feeds URL to find RSS entries. * When it finishes, it calls a refresh to display the entires it found (if any). - * + * * [Esc RATLC00319786] * The second (TimeoutThread) waits for SOCKET_TIMEOUT ms to see if the content thread * has finished reading RSS. If it has finished, nothing further happens. If it has * not finished, the TimeoutThread sets the threadRunning boolean to false and refreshes * the page (basically telling the UI that no content could be found, and removes * the 'Loading...' text). - * + * */ private void createNewsItems() { - + ContentThread contentThread = new ContentThread(); contentThread.start(); TimeoutThread timeThread = new TimeoutThread(); timeThread.start(); } - + /** * Reflows the page using an UI thread. */ @@ -313,7 +313,7 @@ public class EclipseRSSViewer implements IIntroContentProvider { } private Image createImage(IPath path) { - Bundle bundle = Platform.getBundle(IntroPlugin.PLUGIN_ID); + Bundle bundle = Platform.getBundle(IntroPlugin.PLUGIN_ID); URL url = FileLocator.find(bundle, path, null); try { url = FileLocator.toFileURL(url); @@ -483,7 +483,7 @@ public class EclipseRSSViewer implements IIntroContentProvider { private String getParameter(String name) { return (String) params.get(name); } - + private class ContentThread extends Thread{ @Override @@ -506,11 +506,11 @@ public class EclipseRSSViewer implements IIntroContentProvider { SAXParser parser = SAXParserFactory.newInstance().newSAXParser(); parser.parse(in, new RSSHandler()); refresh(); - + } catch (Exception e) { IntroPlugin.logError( NLS.bind( - Messages.RSS_Malformed_feed, + Messages.RSS_Malformed_feed, getParameter("url"))); //$NON-NLS-1$ refresh(); } finally { @@ -533,10 +533,10 @@ public class EclipseRSSViewer implements IIntroContentProvider { timeoutMethod.invoke(conn, new Object[] { new Integer(milliseconds)} ); } catch (Exception e) { // If running on a 1.4 JRE an exception is expected, fall through - } + } } } - + private class TimeoutThread extends Thread { @Override |