Skip to content

Commit 314ce4f

Browse files
tivervactivervac
committed
Some small markdown cleanup
1 parent 1af0dd6 commit 314ce4f

5 files changed

+35
-44
lines changed

‎docs/FAQ/FAQ_Can_I_use_SWT_outside_Eclipse_for_my_own_project.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11

2-
32
FAQ Can I use SWT outside Eclipse for my own project?
43
=====================================================
54

@@ -13,13 +12,10 @@ java -cp swt.jar;. -Djava.library.path=. BrowserSnippet
1312

1413
This command line assumes that java is on your execution path and that both swt.jar and the SWT dynamic link library are located in the current working directory.
1514

16-
17-
1815
See Also:
1916
---------
2017

2118
* [FAQ How do I configure an Eclipse Java project to use SWT?](./FAQ_How_do_I_configure_an_Eclipse_Java_project_to_use_SWT.md "FAQ How do I configure an Eclipse Java project to use SWT?")
2219
* [FAQ How do I create an executable JAR file for a stand-alone SWT program?](./FAQ_How_do_I_create_an_executable_JAR_file_for_a_stand-alone_SWT_program.md "FAQ How do I create an executable JAR file for a stand-alone SWT program?")
2320
* [FAQ\_How\_is\_Eclipse\_licensed?](./FAQ_How_is_Eclipse_licensed.md "FAQ How is Eclipse licensed?")
2421
* [FAQ\_How\_do\_I\_display\_a\_Web\_page\_in_SWT?](./FAQ_How_do_I_display_a_Web_page_in_SWT.md "FAQ How do I display a Web page in SWT?")
25-

‎docs/FAQ/FAQ_How_do_I_display_a_Web_page_in_SWT.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ FAQ How do I display a Web page in SWT?
33

44
In Eclipse 3.0, SWT introduced a browser widget for displaying a native HTML renderer inside an SWT control. Prior to the introduction of this browser, it was necessary to invoke an external Web browser program for displaying rendered HTML. The browser can be instructed to render either a URL or a supplied string containing HTML content. The browser widget does not include the usual controls for navigation, bookmarks, and all the usual bells and whistles associated with a Web browser. As such, it can be used for highly controlled applications, such as displaying help text or even for showing decorated and interactive text inside a view or an editor.
55

6-
The browser has API for programmatically manipulating the content, such as browsing forward or back in the navigation history, refreshing the content, or halting a rendering in process. You can install listeners on the browser to be notified when the location is changing or when the title changes or to receive progress notification as a page loads. It is fairly straightforward to implement basic Web browser functionality around this browser widget. For more details, take a look at BrowserAction in the org.eclipse.faq.examples plug-in. This action implements a fully functional Web browser in fewer than 60 lines of code!
6+
The browser has API for programmatically manipulating the content, such as browsing forward or back in the navigation history, refreshing the content, or halting a rendering in process. You can install listeners on the browser to be notified when the location is changing or when the title changes or to receive progress notification as a page loads. It is fairly straightforward to implement basic Web browser functionality around this browser widget. For more details, take a look at `BrowserAction` in the `org.eclipse.faq.examples` plug-in. This action implements a fully functional Web browser in fewer than 60 lines of code!
77

8-
As a quick example, here is a stand-alone SWT snippet that opens a browser shell on this book's Web site.
8+
As a quick example, here is a stand-alone SWT snippet that opens a browser shell on this book's Website.
99

1010
A title listener is added to the browser in order to update the shell title with the name of the Web page being displayed:
1111

@@ -28,20 +28,20 @@ while (!shell.isDisposed())
2828
display.sleep();
2929
```
3030

31-
Figure 7.1 shows the resulting browser inside a simple shell. The browser widget is not yet available on all platforms as not all platforms that SWT supports have an appropriate native control that can be exploited. For Eclipse 3.0, the browser will at least be available on Windows, Linux, QNX, and MacOS. For platforms that do not have a browser widget available, the Browser constructor will throw an SWT error, allowing you to catch the condition and fall back to an alternative, such as a user-specified external browser.
31+
Figure 7.1 shows the resulting browser inside a simple shell. The browser widget is not yet available on all platforms as not all platforms that SWT supports have an appropriate native control that can be exploited. For Eclipse 3.0, the browser will at least be available on Windows, Linux, QNX, and macOS. For platforms that do not have a browser widget available, the Browser constructor will throw an SWT error, allowing you to catch the condition and fall back to an alternative, such as a user-specified external browser.
3232

33-
How can I invoke the eclipse default web browser in my own plugin?
33+
How can I invoke the Eclipse default web browser in my own plugin?
3434
------------------------------------------------------------------
3535

3636
> > I want to invoke the eclipse default web browser which is specified in
3737
> > "Preferences" -> "General" -> "Web Browser" in my own plugin, giving it
3838
> > a URL and make it visit that URL. How can I do this? Thanks.
3939

40-
I think you want something like...
40+
I think you want something like below.
4141

42-
IWorkbenchBrowserSupport support =
42+
```java
43+
IWorkbenchBrowserSupport support =
4344
PlatformUI.getWorkbench().getBrowserSupport();
44-
IWebBrowser browser = support.createBrowser("someId");
45-
browser.openURL(new URL("https://www.eclipse.org"));
46-
47-
45+
IWebBrowser browser = support.createBrowser("someId");
46+
browser.openURL(new URL("https://www.eclipse.org"));
47+
```

‎docs/FAQ/FAQ_How_do_I_embed_AWT_and_Swing_inside_SWT.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11

2-
32
FAQ How do I embed AWT and Swing inside SWT?
43
============================================
54

6-
In Eclipse 3.0, APIs have been introduced for integrating AWT and Swing with SWT. This support is product-quality on Windows and has only early access support on Linux under JDK 1.5. The main entry point for AWT integration is the class SWT_AWT. It provides a factory method, new_Frame, that creates an AWT Frame that is parented within an SWT Composite. From there, you can create whatever AWT components you want within that frame. The bridging layer created by SWT_AWT handles forwarding of SWT events to the corresponding AWT events within the frame.
5+
In Eclipse 3.0, APIs have been introduced for integrating AWT and Swing with SWT. This support is product-quality on Windows and has only early access support on Linux under JDK 1.5. The main entry point for AWT integration is the class `SWT_AWT`. It provides a factory method, `new_Frame`, that creates an AWT Frame that is parented within an SWT Composite. From there, you can create whatever AWT components you want within that frame. The bridging layer created by `SWT_AWT` handles forwarding of SWT events to the corresponding AWT events within the frame.
76

87
Articles
98
--------
@@ -16,4 +15,3 @@ See Also:
1615
* [FAQ Is SWT better than Swing?](./FAQ_Is_SWT_better_than_Swing.md "FAQ Is SWT better than Swing?")
1716
* [Albireo](https://www.eclipse.org/albireo/) Albireo is an Eclipse Technology project (in incubation phase) that simplifies the task of combining user interface components from the Swing and SWT toolkits. It builds on SWT's standard SWT_AWT bridge, implementing much of the tricky code that is currently left to the developer.
1817
* [DJ project](http://djproject.sourceforge.net/) The other way around. The DJ Project lets you embed SWT components in Swing.
19-

‎docs/FAQ/FAQ_Where_can_I_find_more_information_on_SWT.md‎

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,23 @@ FAQ Where can I find more information on SWT?
44
Contents
55
--------
66

7-
* [1 Books](#Books)
8-
* [2 Web sites](#Web-sites)
9-
* [3 Articles](#Articles)
10-
* [4 Discussion forums](#Discussion-forums)
11-
* [5 See Also](#See-Also)
7+
- [FAQ Where can I find more information on SWT?](#faq-where-can-i-find-more-information-on-swt)
8+
- [Contents](#contents)
9+
- [Books](#books)
10+
- [Websites](#websites)
11+
- [Articles](#articles)
12+
- [Discussion forums](#discussion-forums)
13+
- [See Also](#see-also)
1214

1315
Books
1416
-----
1517

16-
Before 2004, comprehensive information on SWT was not available outside the SWT source code and javadoc itself.
17-
This situation changed in 2004 with the publication of _SWT: The Standard Widget Toolkit_ in the Addison-Wesley Eclipse Series.
18-
This book was written by Steve Northover and Mike Wilson, two of the original architects and developers of SWT.
18+
Before 2004, comprehensive information on SWT was not available outside the SWT source code and Javadoc itself.
19+
This situation changed in 2004 with the publication of _SWT: The Standard Widget Toolkit_ in the Addison-Wesley Eclipse Series.
20+
This book was written by Steve Northover and Mike Wilson, two of the original architects and developers of SWT.
1921
When the acronym first appeared, it was jokingly referred to as Steve's Widget Toolkit.
2022

21-
Nobody knows SWT better than these authors, and their book is the most authoritative guide to the subject.
23+
Nobody knows SWT better than these authors, and their book is the most authoritative guide to the subject.
2224
If you're doing extensive development using SWT, it's indispensable. Volume 2 of their book is forthcoming.
2325

2426
Several other Eclipse books include a chapter or more on SWT:
@@ -28,39 +30,37 @@ Several other Eclipse books include a chapter or more on SWT:
2830
* Sherry Shavor, et al., _The Java Developer's Guide to Eclipse_ (Addison-Wesley, 2004), Chapter 14.
2931
* Rob Warner and Robert Harris, _The Definitive Guide to SWT and JFace_, (Apress, 2004), major part of book.
3032

31-
Web sites
33+
Websites
3234
---------
3335

34-
The information hub for SWT is the [SWT development team home page](https://eclipse.org/swt).
35-
The main page has a basic SWT overview, and the Development Resources page has loads more information, including a comprehensive library of stand-alone SWT programs--called snippets--illustrating many of the important concepts in SWT.
36+
The information hub for SWT is the [SWT development team home page](https://eclipse.org/swt).
37+
The main page has a basic SWT overview, and the Development Resources page has loads more information, including a comprehensive library of stand-alone SWT programs--called snippets--illustrating many of the important concepts in SWT.
3638
This page also hosts the official SWT FAQ maintained by the SWT development team, as well as development plans, platform porting status, and much more.
3739

3840
The home page for SWT and JFace has links to other resource pages, but some information is here, along with a collection of FAQs.
3941

40-
4142
Articles
4243
--------
4344

44-
The first place to look for articles is the articles page on eclipse.org.
45-
We won't bother listing all the articles here as the list would probably be stale by the time this book goes to print.
46-
Of particular note is the two-part article entitled 'SWT: The Standard Widget Toolkit.'
47-
These articles were written by the SWT development team to describe some of the design rationale behind the project.
45+
The first place to look for articles is the articles page on eclipse.org.
46+
We won't bother listing all the articles here as the list would probably be stale by the time this book goes to print.
47+
Of particular note is the two-part article entitled 'SWT: The Standard Widget Toolkit.'
48+
These articles were written by the SWT development team to describe some of the design rationale behind the project.
4849
The CD included with this book has PDF versions of all the articles, captured in May, 2004.
4950

50-
5151
Discussion forums
5252
-----------------
5353

54-
The main forum for discussion of SWT is the eclipse.platform.swt newsgroup.
55-
This is the place to go for all kinds of SWT questions for users of all levels, from novices taking their first steps with SWT to highly experienced SWT developers.
56-
The SWT develoment team regularly reads this newsgroup, so you can be sure of authoritative answers.
54+
The main forum for discussion of SWT is the `eclipse.platform.swt` newsgroup.
55+
This is the place to go for all kinds of SWT questions for users of all levels, from novices taking their first steps with SWT to highly experienced SWT developers.
56+
The SWT development team regularly reads this newsgroup, so you can be sure of authoritative answers.
5757
Be sure to do a [quick search](https://www.eclipse.org/search/search.cgi), before posting, to avoid asking a question that's been asked before.
5858

59-
The platform-swt-dev mailing list is for discussion among members of the SWT development team and other contributors to SWT.
60-
If you are fixing SWT bugs, porting SWT to another platform, or looking for solutions to advanced questions that have not been answered on the newsgroup, you are welcome to ask here.
59+
The `platform-swt-dev` mailing list is for discussion among members of the SWT development team and other contributors to SWT.
60+
If you are fixing SWT bugs, porting SWT to another platform, or looking for solutions to advanced questions that have not been answered on the newsgroup, you are welcome to ask here.
6161
SWT users are welcome to subscribe and follow along with the discussion, but to avoid cluttering the developer list, please use the newsgroup for your questions.
6262

63-
Some other Java forums have been known to host discussion threads on SWT. Unfortunately, these forums can sometimes deteriorate into flame wars on Swing versus SWT.
63+
Some other Java forums have been known to host discussion threads on SWT. Unfortunately, these forums can sometimes deteriorate into flame wars on Swing versus SWT.
6464

6565
See Also
6666
--------
@@ -69,4 +69,3 @@ See Also
6969
* [FAQ What Eclipse mailing lists are available?](./FAQ_What_Eclipse_mailing_lists_are_available.md "FAQ What Eclipse mailing lists are available?")
7070
* [FAQ What articles on Eclipse have been written?](./FAQ_What_articles_on_Eclipse_have_been_written.md "FAQ What articles on Eclipse have been written?")
7171
* [FAQ What books have been written on Eclipse?](./FAQ_What_books_have_been_written_on_Eclipse.md "FAQ What books have been written on Eclipse?")
72-

‎docs/FAQ/FAQ_Why_does_Eclipse_use_SWT.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11

2-
32
FAQ Why does Eclipse use SWT?
43
=============================
54

@@ -15,4 +14,3 @@ See Also:
1514
---------
1615

1716
* [FAQ How do I embed AWT and Swing inside SWT?](./FAQ_How_do_I_embed_AWT_and_Swing_inside_SWT.md "FAQ How do I embed AWT and Swing inside SWT?")
18-

0 commit comments

Comments
 (0)