Skip to content

Cleanup root AsciiDoc files #1186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 29, 2025
Merged

Cleanup root AsciiDoc files #1186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions ...b.doc.user/html-src/accesibility.asciidoc → ....doc.user/html-src/accessibility.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
ifdef::env-github[]
:imagesdir: ../html
endif::[]

= Accessibility

The tool provides the following accessibility features:
Expand All @@ -10,21 +14,21 @@ palette and property pane can be traversed using the arrow keys.
component tree and design view as well as for the currently selected
property.

____
--
image:userinterface/images/single_selection.png[image]
____
--

* Color preferences are provided to control feedback for most layout
managers.

* Color is used as an enhancement to various feedbacks in the design
view.

____
image:userinterface/images/feedback_drag_grid1.png[image,width=229,height=124] 
image:userinterface/images/feedback_drag_grid2.png[image,width=229,height=124] 
image:userinterface/images/feedback_drag_grid3.png[image,width=229,height=124]
____
--
image:userinterface/images/feedback_drag_grid1.png[image] 
image:userinterface/images/feedback_drag_grid2.png[image] 
image:userinterface/images/feedback_drag_grid3.png[image]
--

* System high contrast settings are respected
* System fonts, colors and sizes are inherited
Expand Down
55 changes: 22 additions & 33 deletions org.eclipse.wb.doc.user/html-src/error_reporting.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
ifdef::env-github[]
:imagesdir: ../html
endif::[]

== Error Reporting

When something unexpected happens (such as an exception being thrown)
while trying to parse a user interface class or perform a design view
operation, the editor will display the following error page:

[width="100%",cols="50%,50%"]
|===
a|
image:images/error_handling_page.png[image]
a|
The *link:#CreateReportDialog[Create Report]* button opens up an error

The xref:#CreateReportDialog[*Create Report*] button opens up an error
reporting dialog that will create a bug report that you can submit to
the bug tracking system along with all the needed supporting details.

link:#CreateReportDialog[image:images/create_report_button.png[image,width=133,height=42]]
xref:#CreateReportDialog[image:images/create_report_button.png[image]]

The *Reparse* button will cause the current class to be reparsed.

Expand All @@ -23,7 +24,6 @@ The *Switch to code* button will switch the editor back to the *Source*
view.

image:images/switch_to_code_button.png[image]
|===

Clicking the *Show stack trace* link will reveal the captured stack
trace. Clicking the link a second time will hide the stack trace.
Expand All @@ -36,34 +36,31 @@ image:images/error_handling_page_stack_trace.png[image]
Clicking the *Create Report* button will open the *Create Report
Dialog*:

[width="100%",cols="50%,50%"]
|===
a|
image:images/create_report_dialog.png[image,width=394,height=243]
a|
image:images/create_report_dialog.png[image]

The dialog contains several fields for entering information about the
problem and several options for attaching important support info:

* The Eclipse workspace *.metadata/.log* file is attached. This contains
any exceptions triggered as part of the error.
* A *link:#Screenshots[screenshot]* of the design view immediately prior
* A xref:#Screenshots[*screenshot*] of the design view immediately prior
to the exception will be attached. Additional screenshots may be
attached.
* The *Compilation unit of error* (the currently edited class) may be
optionally attached (this is recommended).
link:support/test_cases.html[Reproducible test cases] are very important
xref:support/test_cases.adoc[Reproducible test cases] are very important
for quick problem resolution.
* The *Entire project of error* (the currently edited project) may be
optionally attached (recommended if the current class has a lot of
dependencies). link:support/test_cases.html[Reproducible test cases] are
dependencies). xref:support/test_cases.adoc[Reproducible test cases] are
very important for quick problem resolution, so including any classes
needed to compile the class you are editing can be important.
* A *link:#SoftwareHardwareSummary[Software and hardware summary]* is
* A xref:#SoftwareHardwareSummary[*Software and hardware summary*] is
automatically attached to the case in order to identify any possible
conflicts.
* The WindowBuilder *preferences* are automatically attached to the
case.
* Any additional *link:#FileAttachments[File attachments]* may be
* Any additional xref:#FileAttachments[*File attachments*] may be
optionally added to the case (your *eclipse.ini* file, for example, or
any other classes needed by the class you are editing).

Expand All @@ -73,20 +70,17 @@ manually submitted to the
discussions]* or bug tracking system
(*https://github.com/eclipse-windowbuilder/windowbuilder/issues[GitHub
Issues]*).
|===

[#ProductInfo]
=== Screenshots

Click on the *Screenshots [.underline]#add..#* link to attach additional
screenshots to the case.

++++
<p>
<img src="images/screenshots1.png">
<img src="images/screenshots2.png" align="top">
</p>
++++
--
image:images/screenshots1.png[image]
image:images/screenshots2.png[image]
--

[#SoftwareHardwareSummary]
=== Software and hardware summary
Expand All @@ -102,16 +96,11 @@ image:images/software_and_hardware_info.png[image]

Click on the *File attachments [.underline]#add..#* link to attach
additional files to the case (such as your *eclipse.ini* file).
--
image:images/file_attachments1.png[image]
image:images/file_attachments2.png[image]
--

++++
<p>
<img src="images/file_attachments1.png">
<img src="images/file_attachments2.png" align="top">
</p>
++++

[#ContactOptions]
[#SubmitManually]
== Manually submit to discussions or bug tracking system

A ZIP file that includes all of the case data (including any images and
Expand Down
85 changes: 45 additions & 40 deletions org.eclipse.wb.doc.user/html-src/faq.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,49 +1,54 @@
= WindowBuilder Pro FAQ
ifdef::env-github[]
:imagesdir: ../html
endif::[]

= WindowBuilder FAQ

The following are frequently asked questions about WindowBuilder: 

* link:#UpdateManager[What should I do if I'm getting errors using the
* xref:#UpdateManager[What should I do if I'm getting errors using the
Update Manager?]
* link:#OtherGUIBuilders[Can WindowBuilder Pro edit windows created with
* xref:#OtherGUIBuilders[Can WindowBuilder Pro edit windows created with
JBuilder, VA Java, NetBeans, VisualCafe, etc.?]
* link:#CreatedByHand[Can WindowBuilder Pro edit windows that have been
* xref:#CreatedByHand[Can WindowBuilder Pro edit windows that have been
created by hand?]
* link:#Refactor[Can I refactor or otherwise modify the WindowBuilder
* xref:#Refactor[Can I refactor or otherwise modify the WindowBuilder
Pro generated code?]
* link:#SpecialTags[Why doesn't WindowBuilder Pro surround generate code
* xref:#SpecialTags[Why doesn't WindowBuilder Pro surround generate code
with special tags or mark it as read-only?]
* link:#CantParse[Are there any specific constructs that WindowBuilder
* xref:#CantParse[Are there any specific constructs that WindowBuilder
Pro can't parse?]
* link:#Constructor[Why does WindowBuilder Pro generate in the
* xref:#Constructor[Why does WindowBuilder Pro generate in the
constructor?]
* link:#CustomWidgets[Can WindowBuilder Pro use custom widgets?]
* link:#InstantiationException[What should I do if I encounter an
* xref:#CustomWidgets[Can WindowBuilder Pro use custom widgets?]
* xref:#InstantiationException[What should I do if I encounter an
InstantiationException or other error when using a custom widget?]
* link:#Installation[What should I do if WindowBuilder Pro does not
* xref:#Installation[What should I do if WindowBuilder Pro does not
appear after installation?]
* link:#DoesNotWork[What should I do if WindowBuilder Pro does not work
* xref:#DoesNotWork[What should I do if WindowBuilder Pro does not work
after installation?]
* link:#DesignTab[What can I do if I don't see the Design tab when I
* xref:#DesignTab[What can I do if I don't see the Design tab when I
edit a window?]
* link:#Exception[What should I do if I encounter an exception using
* xref:#Exception[What should I do if I encounter an exception using
WindowBuilder Pro?]
* link:#ParsingError[What should I do if I encounter Parsing Error?]
* link:#OutOfMemoryError[What should I do if I encounter an
* xref:#ParsingError[What should I do if I encounter Parsing Error?]
* xref:#OutOfMemoryError[What should I do if I encounter an
OutOfMemoryError using WindowBuilder Pro?]
* link:#NoSuchMethodError[What should I do if I encounter an
NoSuchMethodError or] link:#NoClassDefFoundError[NoClassDefFoundError
* xref:#NoSuchMethodError[What should I do if I encounter an
NoSuchMethodError or] xref:#NoClassDefFoundError[NoClassDefFoundError
using WindowBuilder Pro?]
* link:#UnsupportedClassVersionError[What should I do if I encounter an
* xref:#UnsupportedClassVersionError[What should I do if I encounter an
UnsupportedClassVersionError using WindowBuilder Pro?]
* link:#UnsatisfiedLinkError[What should I do if I encounter an
* xref:#UnsatisfiedLinkError[What should I do if I encounter an
UnsatisfiedLinkError when launching my SWT application?]
* link:#Linux[How should WindowBuilder Pro be configured to work on
* xref:#Linux[How should WindowBuilder Pro be configured to work on
Linux?]
* link:#SuSELinux[What should I do if I have problems running under SuSE
* xref:#SuSELinux[What should I do if I have problems running under SuSE
Linux?]
* link:#LinuxFlashing[How can I prevent the preview window from flashing
* xref:#LinuxFlashing[How can I prevent the preview window from flashing
under Linux using Metacity]

[#UpdateManager]
== What should I do if I'm getting errors using the Update Manager?

If you encounter some sort of Eclipse Update Manager failure with
Expand Down Expand Up @@ -228,7 +233,7 @@ within WindowBuilder Pro and false at runtime.

An InstantiationException means that WindowBuilder Pro could not create
an instance of a particular class. The most common reason for this is
that the component is not a link:#CustomWidgets[valid custom widget]. In
that the component is not a xref:#CustomWidgets[valid custom widget]. In
order to be a valid Swing widget, a class must be a valid Java Bean and
have a public, zero-argument constructor. SWT widgets must have a public
two-argument constructor with parent and style bits as the two
Expand All @@ -253,7 +258,7 @@ answer true when the component is loaded within WindowBuilder Pro and
false at runtime.

More detail about the use of custom widgets is available in
link:#CustomWidgets[this FAQ entry].
xref:#CustomWidgets[this FAQ entry].

[#Installation]
== What should I do if WindowBuilder Pro does not appear after installation?
Expand All @@ -274,12 +279,12 @@ from your eclipse directory and restore those directories from the
Eclipse ZIP file.

After restarting Eclipse, open the Eclipse preference dialog and confirm
that you see a link:preferences/index.html[WindowBuilder preference
page]. If *WindowBuilder Pro* still does not appear, check your Eclipse
that you see a xref:preferences/index.adoc[WindowBuilder preference
page]. If *WindowBuilder* still does not appear, check your Eclipse
".log" file (found in your <workspace>/.metadata directory) for any
recorded exceptions and then contact support.If no exceptions are
present and *WindowBuilder Pro* is still not present, make sure that you
are using a properly configured Eclipse-based IDE. *WindowBuilder Pro*
present and *WindowBuilder* is still not present, make sure that you
are using a properly configured Eclipse-based IDE. *WindowBuilder*
requires the complete *Eclipse SDK* to be present, and will not load
into an Eclipse subset (like EasyEclipse or the MyEclipse All-in-one
edition). The most important piece missing from some Eclipse
Expand Down Expand Up @@ -332,13 +337,13 @@ image:features/images/open_with.png[image]

Eclipse remembers the last editor type used with a file. If you don't see the
*Design* tab, that means that you are using the standard Eclipse *Java Editor*
rather than the *link:features/editing_existing_window.html[WindowBuilder Editor]*.
rather than the xref:features/editing_existing_window.adoc[*WindowBuilder Editor*].
Open the file with the
*link:features/editing_existing_window.html[WindowBuilder Editor]* and
xref:features/editing_existing_window.adoc[*WindowBuilder Editor*] and
you will see both the *Source* and *Design* tabs. Note that Eclipse will
only let you have a file open with one editor at a time, so you may need
to close any existing editor before opening it with the
*link:features/editing_existing_window.html[WindowBuilder Editor]*.
xref:features/editing_existing_window.adoc[*WindowBuilder Editor*].

image:features/images/source_design.png[image,width=252,height=70]

Expand All @@ -351,13 +356,13 @@ problem. If the problem has been reported in the past, there is a good
chance that it has already been fixed. If the problem still exists, you
should send your Eclipse ".log" file (found in your
*<workspace>/.metadata* directory) as well as any relevant test cases to
link:support/product_support.html[support]. Including a
link:support/test_cases.html[test case] that will help us reproduce the
xref:support/product_support.adoc[support]. Including a
xref:support/test_cases.adoc[test case] that will help us reproduce the
problem is very important. The faster we can reproduce the problem, the
faster we can get you a fix. If we can't reproduce a problem, there is
little we can do to help you.

Ideally, the link:support/test_cases.html[test case] you send should be
Ideally, the xref:support/test_cases.adoc[test case] you send should be
the same window you were editing when the problem occurred (along with
any supporting files needed to compile it). If that is not possible
(possibly because you aren't allowed to send any code to a 3rd party),
Expand All @@ -374,14 +379,14 @@ As suggested by the message, this is error is caused by a parsing
problem. It has nothing to do with licensing. Your Eclipse ".log" file
(found in your *<workspace>/.metadata* directory) should provide a hint
as to the cause of the parsing error. Send the log file as well as a
test case to link:support/product_support.html[support] (ideally the
test case to xref:support/product_support.adoc[support] (ideally the
window you are trying to edit). Including a
link:support/test_cases.html[test case] that will help us reproduce the
xref:support/test_cases.adoc[test case] that will help us reproduce the
problem is very important. The faster we can reproduce the problem, the
faster we can get you a fix. If we can't reproduce a problem, there is
little we can do to help you.

Ideally, the link:support/test_cases.html[test case] you send should be
Ideally, the xref:support/test_cases.adoc[test case] you send should be
the same window you were editing when the problem occurred (along with
any supporting files needed to compile it). If that is not possible
(possibly because you aren't allowed to send any code to a 3rd party),
Expand All @@ -392,7 +397,7 @@ the problem at hand (e.g., keep deleting code until the problem goes
away and then restore that last code that was last deleted).

Parsing problems can also be a side effect of the other problems
described in the link:#DoesNotWork[earlier FAQ entry here] so check each
described in the xref:#DoesNotWork[earlier FAQ entry here] so check each
of the suggestions there. Refreshing and rebuilding your project using
the *Project > Clean* command can often help as can cleaning your
Eclipse "configuration" directory.
Expand Down Expand Up @@ -460,7 +465,7 @@ properly. If a plugin does not load, all of its methods will be
unreachable, and any attempts to access them will trigger a
NoSuchMethodError or NoClassDefFoundError. This problem can usually be
fixed by cleaning your Eclipse "configuration" directory as described in
this link:#DoesNotWork[earlier FAQ entry].
this xref:#DoesNotWork[earlier FAQ entry].

[#UnsupportedClassVersionError]
== What should I do if I encounter an UnsupportedClassVersionError using WindowBuilder Pro?
Expand Down
Loading
Loading