From jbosstools-commits at lists.jboss.org Tue Mar 16 12:34:19 2010
Content-Type: multipart/mixed; boundary="===============5879620756762108559=="
MIME-Version: 1.0
From: jbosstools-commits at lists.jboss.org
To: jbosstools-commits at lists.jboss.org
Subject: [jbosstools-commits] JBoss Tools SVN: r20846 -
trunk/jsf/docs/userguide/en-US.
Date: Tue, 16 Mar 2010 12:34:19 -0400
Message-ID: <201003161634.o2GGYJl9001799@svn01.web.mwc.hst.phx2.redhat.com>
--===============5879620756762108559==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Author: abogachuk
Date: 2010-03-16 12:34:18 -0400 (Tue, 16 Mar 2010)
New Revision: 20846
Modified:
trunk/jsf/docs/userguide/en-US/editors.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-1127
https://jira.jboss.org/jira/browse/JBDS-1132
Modified: trunk/jsf/docs/userguide/en-US/editors.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/jsf/docs/userguide/en-US/editors.xml 2010-03-16 16:06:57 UTC (rev=
20845)
+++ trunk/jsf/docs/userguide/en-US/editors.xml 2010-03-16 16:34:18 UTC (rev=
20846)
@@ -8,14 +8,10 @@
Editor
-
EditorsIn the JSF Tools Reference Guide and Struts Tools Reference Guid=
e you had possibility to
- read about Graphical Editor for JSF
- and Struts configuration
- files, Graphical Editor for
- Tiles Files, Graphical Editor for
- Struts Validation Files. All these editors have
OpenOn
and
@@ -24,39 +20,35 @@
to know a Visual Page Editor =
for combined visual and
source editing of Web pages and many other editors for
different types of files.
-
-
Editors Features
- JBoss Developer Studio has powerful edi=
tor features that help you easily navigate
- within your application and make use of content and code assis=
t no matter what project
- file (.jsp, .xhtml, .xml, .css, etc.) you are working on.
- The mentioned features are the following:
- =
-
-
- OpenOn<=
/link>
-
-
- Content Assist
-
-
- Synchronized Source and Visual Editing
-
-
- =
+ JBoss Developer Studio has powerful edi=
tor features that help you
+ easily navigate within your application and make use of conten=
t and code assist no
+ matter what project file (.jsp, .x=
html, .xml, .css, etc.) you are wo=
rking on.
+ The mentioned features are the following:
+
+
+ OpenOn
+
+
+ Content
+ Assist
+
+
+ Synchronized Source and Visual Editing
+
+
-
OpenOn
-
- OpenOn lets you easily link directly from one resource to
- another in your project without using the Packag=
e Explorer view (project tree). With
+ OpenOn lets you easily link directly from one resource t=
o another in your project
+ without using the Package Explorer vi=
ew (project tree). With
OpenOn, you can simply use F3 or Ctrl+Click on a reference to another file and the file wi=
ll be opened.
-
OpenOn is available for:
@@ -73,163 +65,157 @@
Java files
- CSS classes
+
+ CSS classes
+
- Paths to f=
iles set using EL variable
+
+ Paths to files=
set using EL
+ variable
+
- =
-
XML Files
-
- Press and hold down the Ctrl key. As you move the mouse cursor over different
- file references in the file, they display an underline=
. When you hover the name
- of the file you want to open, click and the file will =
open in its own editor.
- =
- Use the OpenOn functionality for the next entries=
defined in XML file:
- =
-
-
- Managed beans
- In this example the managed bean "User" will open.
- =
-
- Opening a Managed Bean
-
-
-
-
-
-
- =
- This is the result of using OpenOn.
- =
-
- Opened Managed Bean
-
-
-
-
-
-
-
- =
-
- Beans properties
-
- OpenOn for the Bean Property
-
-
-
-
-
-
-
- =
-
- JSP file references
-
- OpenOn for JSP Page
-
-
-
-
-
-
-
-
+ Press and hold down the Ctrl key. As
+ you move the mouse cursor over different file referenc=
es in the file, they
+ display an underline. When you hover the name of the f=
ile you want to open,
+ click and the file will open in its own editor.
+ Use the OpenOn functionality for the next entries de=
fined in XML file:
+
+
+ Managed beans
+ In this example the managed bean <=
property
+ >"User" will open.
+
+ Opening a Managed Bean
+
+
+
+
+
+
+ This is the result of using OpenOn.
+
+ Opened Managed Bean
+
+
+
+
+
+
+
+
+ Beans properties
+
+ OpenOn for the Bean Property
+
+
+
+
+
+
+
+
+ JSP file references
+
+ OpenOn for JSP Page
+
+
+
+
+
+
+
+
- =
-
JSP/XHTML Pages
-
- OpenOn is also available in JSP and XHTML pages edit=
ed in the Visual Page Editor. It will allow
- you to quickly jump to the reference instead of having=
to hunt around in the
- project structure.
-
- =
- You can use OpenOn for the following JSP/XHTML file ent=
ries:
- =
-
-
- Imported property files
-
- OpenOn for Property File Imported to the JSP Page=
title>
-
-
-
-
-
-
-
- =
-
- CSS files used in a JSP/XHTML page
-
- OpenOn With CSS File
-
-
-
-
-
-
-
- =
-
- Managed beans and their properties
-
- OpenOn With Managed Beans
-
-
-
-
-
-
-
- =
-
- Navigation rules in JSP files
- =
- For JSP files in a JSF project, you can easily open t=
he navigation rules
- by applying OpenOn to the JSF tag for=
the navigation
- outcome:
- =
-
- OpenOn with JSF Tag
-
-
-
-
-
-
-
- =
-
- Custom Facelets tag libraries in XHTML pages =
=
- For details, see "OpenOn for Custom Facelets Tag Libraries"
- later in this guide.
-
- =
-
- Custom JJSF 2.0 components =
-
- OpenOn with JSF 2.0 Component
-
-
-
-
-
- =
-
-
+ OpenOn is also available in JSP and XHTML pages edit=
ed in the Visual
+ Page Editor. It will allow you to quick=
ly jump to the reference
+ instead of having to hunt around in the project struct=
ure.
+ You can use OpenOn for the following JSP/XHTML file =
entries:
+
+
+ Imported property files
+
+ OpenOn for Property File Imported to th=
e JSP Page
+
+
+
+
+
+
+
+
+ CSS files used in a JSP/XHTML page
+
+ OpenOn With CSS File
+
+
+
+
+
+
+
+
+ Managed beans and their properties
+
+ OpenOn With Managed Beans
+
+
+
+
+
+
+
+
+ Navigation rules in JSP files
+ For JSP files in a JSF project, you can easi=
ly open the navigation
+ rules by applying OpenOn =
to the JSF tag for the
+ navigation outcome:
+
+ OpenOn with JSF Tag
+
+
+
+
+
+
+
+
+ Custom Facelets tag libraries in XHTML pages=
+ For details, see "OpenOn
+ for Custom Facelets Tag Libraries" later in this
+ guide.
+
+
+ Custom JSF 2.0 components
+
+ OpenOn with JSF 2.0 Component
+
+
+
+
+
+
+
+
- =
CSS Classes
- You can quickly navigate through CSS classes using Op=
enOn
+ You can quickly navigate through CSS classes using O=
penOnOpenOn With CSS Class
@@ -238,8 +224,7 @@
- =
- OpenOn is also implemented for css classes added by =
a complex link. =
+ OpenOn is also implemented for css classes added by =
a complex link.OpenOn With CSS Class added by a complex link=
title>
@@ -249,34 +234,26 @@
- =
OpenOn for EL variablesOpenOn can be used for paths to files set with EL va=
riable.
-
- OpenOn for paths to files set with EL variable
-
-
-
-
-
-
- =
+
+ OpenOn for paths to files set with EL variable<=
/title>
+
+
+
+
+
+
- =
-
-
Content AssistContent assist is available when wo=
rking with
-
-
- Seam project files
-
-
+ Seam project files
@@ -293,123 +270,121 @@
JSP files
-
-
- XHTML files
-
-
- RichFaces com=
ponents
+ XHTML=
files
- ESB XML files
+ RichFaces com=
ponents
+ ESB XML files
+
+
Insert=
Tag Wizard
-
Notice, that code completion for EL variables has icons =
illustrating what they are
- from. The most of this icons are described in the table below.=
+ from. The most of this icons are described in the table be=
low.
Content assist icons
-
+
- Icon
- Type
- Context
+ Icon
+ Type
+ Context
-
-
-
-
-
-
-
-
-
- Enumeration =
=
-
-
-
- Used to show items which exist in the=
predefined set of equivalent proposals.
-
-
-
-
-
-
+
+
+
- Seam Proposal
+ Enumeration
- Used to show Seam Context variables,=
its properties and methods. =
- =
-
- =
+ Used to show items which exist in th=
e predefined set of
+ equivalent proposals.
+
-
-
-
+
+
+
- JSF EL
-
+ Seam Proposal
- Used to show Managed Beans, Managed =
Bean Properties, Managed Bean Methods, Constants, Resource Bundles, Resourc=
e Bundle Properties. =
- =
- =
-
+ Used to show Seam Context variables,=
its properties and
+ methods.
- =
-
-
-
+
+
+
- JSF Action
- =
-
+ JSF EL
- Used to show navigation rules defin=
ed in the faces-config.xml .
- =
+ Used to show Managed Beans, Managed =
Bean Properties, Managed
+ Bean Methods, Constants, Resource Bund=
les, Resource Bundle
+ Properties.
+
+
+
+
+
+
+
+
+
+ JSF Action
+
+
+ Used to show navigation rules define=
d in the faces-config.xml .
+
-
-
-
+
+
+
@@ -417,36 +392,30 @@
Used to show Messages Reso=
urces items.
- =
- =
-
-
-
+
+
+
- Resource path
-
+ Resource path Used to show paths which are accessi=
ble from the cursor place.
- =
- =
- =
- =
-
JSF Content Assist
@@ -455,7 +424,6 @@
-
Seam Content Assist
@@ -464,23 +432,19 @@
-
Also, as you can see, the ranking and sorting are availa=
ble in EL code
completions.
-
-
JSF Project Files
-
When working with JSF project in JBoss Developer Stu=
dio, you can use various
Content Assist features while=
developing:
- Content Assist for XML, XHTML, JSP and JSF =
configuration files
- =
+ Content Assist for XML, XHTML, JSP and JSF c=
onfiguration files
+
Content Assist for Composite Components
- =
+
Content Assist based on project data
@@ -488,16 +452,12 @@
Content Assist with graphical JSF editor
- =
-
Content Assist for XML, JSP and JSF configurati=
on files
-
At any point when working with any XML, JSP and =
JSF configuration files
Content Assist is available to help you. Simply ty=
pe Ctrl-Space to see what is available.
-
Content Assist for JSF configuration file:Content Assist in JSF Configuration File
@@ -528,29 +488,26 @@
- =
- =
+ Content Assist for Composite Components
- Content assist functionality is also available f=
or composite components. On the screen is shown content assist for a compos=
ite component file "tag.xhtml" within a JSF=
1.2 project with facelets
- =
+ Content assist functionality is also available f=
or composite components.
+ On the screen is shown content assist for a compos=
ite component file
+ "tag.xhtml" wit=
hin a JSF 1.2 project with
+ faceletsContent Assist for Composite Components
-
- =
- =
- =
- =
+
-
Content Assist Based on Project Data
-
JBoss Developer Studio takes Content Assist to t=
he next level. Studio will
constantly scan your project and you will be able =
to insert code into the
JSP page from your project that includes:
@@ -590,11 +547,9 @@
In the following screenshot we are inserting a <=
emphasis role=3D"italic">
"Managed bean"
- attribute value. Again, by simply clic=
king
- Ctrl-Space,=
JBoss
- Developer Studio will show a list of all possible =
values that you can
- insert.
-
+ attribute value. Again, by simply clic=
king Ctrl-Space, JBoss D=
eveloper Studio will show
+ a list of all possible values that you can insert.=
Once you select a Managed bean, it will show you=
a list of all available
attributes for the selected Managed bean (userBean=
).
@@ -617,35 +572,32 @@
- =
- Code Assist can also provide you with access to =
the beans located in jar archives.
- =
+ Code Assist can also provide you with access to =
the beans located in jar
+ archives.
- Code Assist: accessing beans in jar archives
-
-
-
-
-
+ Code Assist: accessing beans in jar archive=
s
+
+
+
+
+
- Moreover Code Assist is abl=
e to define Resource Bundles on template page and give=
s the proposals on the client page.
+ Moreover Code Assist is abl=
e to define Resource Bundles on template page =
and gives the proposals on
+ the client page. Code Assist: Message Bundles proposals from=
template page
-
+
- =
- =
- =
-
Content Assist within Tree JSF Editor
-
JBoss Developer Studio also provides Content Ass=
ist when working within
the Tree JSF configuration editor. Just click Ctrl-Space. =
para>
@@ -658,7 +610,6 @@
-
-
Struts Project FilesContent Assist features are available when you work =
with Struts
projects.
-
-
-
-
Content Assist for Struts Configuration File
-
Content Assist helps you in Struts Configuration=
file.
-
Struts Content Assist
@@ -769,11 +713,8 @@
-
Content Assist for Struts JSP File
-
Using Code Assist in Struts JSP file is shown be=
low.
-
Struts JSP Content Assist
@@ -786,15 +727,10 @@
-
JSP Pages
-
-
-
Content Assist for JSF TagsJBDS provides full code completion for JSF tags:=
-
JSF Tags Content Assist
@@ -816,10 +752,8 @@
-
-
Content Assist for JSTL TagsJSTL Tags Content Assist
@@ -832,7 +766,6 @@
-
Content Assist for HTML TagsContent assist for HTML tags has the same mechan=
ism as for JSF
tags:
@@ -857,7 +790,6 @@
-
Content Assist for JavaScript TagsJavaScript Tags Content Assist
@@ -870,26 +802,27 @@
-
-
- Content Assist for XHTML Pages
- =
- The code completion for the Seam components in a Seam proj=
ect shows the proposals marked with Seam icon.
-
- Content Assist for Seam Components in the XHTML Page
-
-
-
-
-
-
- =
- If XHTML file uses custom Facelets components, the Content=
Assist should also be available for them. For details, see
- "Content =
Assist for Custom Facelets Components" later in this guide.
-
+
+ Content Assist for XHTML Pages
+ The code completion for the Seam components in a Sea=
m project shows the
+ proposals marked with Seam icon.
+
+ Content Assist for Seam Components in the XHTML=
Page
+
+
+
+
+
+
+ If XHTML file uses custom Facelets components, the C=
ontent Assist should also
+ be available for them. For details, see "C=
ontent Assist for Custom
+ Facelets Components" later in this gui=
de.
+ Content Assist for Insert Tag Wizard
- Content Assist is also available for any attribute v=
alue of Insert Tag wizard.
+ Content Assist is also available for any attribute v=
alue of Insert
+ Tag wizard.Content Assist for Insert Tag Wizard
@@ -898,11 +831,8 @@
- =
- =
-
Adding dynamic code assist to custom components tha=
t were added to JBoss
Tools PaletteHere is what you need to do to add project based cod=
e assist to a custom
@@ -922,8 +852,7 @@
Adds code assist for JSF pre-defined objects=
, such as
- value=3D"#{param}"
- :
+ value=3D"#{param}" =
:
@@ -987,15 +916,16 @@
uri=3D"http://www.jenia.org/jsf/dataTools"/>]]>
-
Restart Eclipse. You should now have code as=
sist for the
component.
- From JBoss Developer Studio 3.0.0.M1 you should not do any of the steps described =
- before,dynamic code assist to custom components is added a=
utomatically.
- If you open projects that were created in older stud=
io versions such message could appear:
+ From JBoss Developer Studio 3.0.0.M1 you should not do
+ any of the steps described before,dynamic code assist =
to custom components is
+ added automatically.
+ If you open projects that were created in older stud=
io versions such message
+ could appear:Missing Natures Message
@@ -1004,28 +934,33 @@
- It shows that some features of content assist includ=
ing this one probably will not work.
- To fix this problem and turn off the message box execu=
te the following steps:
+ It shows that some features of content assist includ=
ing this one probably will
+ not work. To fix this problem and turn off the message=
box execute the following
+ steps:
- Right click the project in Package Exp=
lorer.
- Select Configure -> Add JSF =
Capabilities from the context menu.
- Configure your project using Add JSF C=
apabilities wizard and press Finish
+
+ Right click the project in Package Explorer.=
+
+
+ Select Configure -> Add JSF Capabi=
lities from the
+ context menu.
+
+
+ Configure your project using Add JSF Capabil=
ities wizard and press
+ Finish
+
-
Synchronized Source and Visual Editing
-
JBoss Developer Studio offers the f=
lexibility to edit any
files in either source or extra visual modes at the same t=
ime.
-
The project is yours and so is the source. JBo=
ss Developer
Studio provides you many different graphica=
l editors to speed your
application development. At the same time, you always have=
a full control over all
project source files. Any changes you make in the source v=
iew immediately appear in
the graphical view.
-
The JSF configuration file editor has three views: Diagram,
Tree and Source. All views are
synchronized, you can edit the file in any view.
@@ -1038,13 +973,10 @@
-
The same is relevant to all other JBoss Develo=
per Studio
editors.
-
Web XML editor is shown. Web XML editor has a graphical =
view (Tree) and source
(Source).
-
Two Views are Synchronized
@@ -1054,7 +986,6 @@
-
JBoss Developer Studio TLD file edi=
tor is shown in Tree view.
At any point you can edit the source by switching to Sourc=
e view.
@@ -1066,29 +997,31 @@
-
-
Visual Page Editor
-
JBoss Developer Studio comes with a pow=
erful and customizable
Visual Page Editor (VPE). You can use=
the Visual Page Editor to
- develop an application using any technology: JSF, Struts, JSP,=
HTML and others. Double-click on the necessary file in the Package Explore=
r view to open it in the Visual Editor or just drag-and-drop it into perspe=
ctive (the drag-and-drop feature can be also applied to JSP, XHTML or HTML =
files created locally).
-
- As a new JSF 2.0 specification has been released, support of =
new features is now implemented in the Visual Page Editor.
- The JSF 2.0 tags like <h:body>, =
<h:head>, <h:outputscript>, <h:outputstyle>
- are supported in the editor as well as the composite components an=
d the resource handling from the expression language. (See the fo=
llowing link on how to use composite components and =
- following blog post on how to handle the resources form the EL).
-
- =
- Current VPE version has three tabs: Visual/Source,
- Source and Preview. To switch between the
- views you can use tabs at the bottom of the VPE or the shortcu=
ts
+ develop an application using any technology: JSF, Struts, JSP,=
HTML and others.
+ Double-click on the necessary file in the Package Explorer vie=
w to open it in the Visual
+ Editor or just drag-and-drop it into perspective (the drag-and=
-drop feature can be also
+ applied to JSP, XHTML or HTML files created locally).
+ As a new JSF 2.0 specification has been released, support of=
new features is now
+ implemented in the Visual Page Editor. Th=
e JSF 2.0 tags like
+ <h:body>, <h:head>=
, <h:outputscript>, <h:outputst=
yle> are
+ supported in the editor as well as the composite components an=
d the resource handling
+ from the expression language. (See the following
+ link on how to use composite components and following blog
+ post on how to handle the resources form the EL). =
+ Current VPE version has three tabs: Visual/Source<=
/property>, Source and Preview. To sw=
itch between the views you
+ can use tabs at the bottom of the VPE or the shortcuts Ctrl + PageUp/Ctrl + PageDown
.
-
Visual Page Editor
@@ -1097,10 +1030,8 @@
-
Visual/Source View
-
Using the Visual/Source view you ca=
n edit your pages in the
Source and Visual modes simultaneously having an instant s=
ynchronization between
them:
@@ -1112,11 +1043,9 @@
-
The view is designed in the form of a split pane with to=
ggle buttons for quickly
moving between Source, Visual or Source/Visual modes as sh=
own on the figure
above.
-
One more way to toggle between the various states of the=
split pane is using the
shortcuts Shift + F6
@@ -1128,7 +1057,6 @@
When editing large documents hiding the Visual part =
will speed up the
editing.
-
It should be pointed out that, no matter in what mode yo=
u are working, you get a
full integration with Properties and =
Outline
views:
@@ -1140,12 +1068,16 @@
-
-
- The Outline view displays a specific outline of a struct=
ured file that is currently open in the editor area, and lists its structur=
al elements. Right-click on the elements will open additional options that =
allow adding other specific elements in necessary positions.
- The Properties view shows property names and their value=
s for a selected item. The values are editable, just select any and click o=
n the button that appeared to choose a new value. Key combination Ctrl+Z will return the previous value, Ctrl+Y will return the new value again. The Properties view has additional opt=
ions and can be set up to display categories and advanced properties.
-
-
+ The Outline view displays a specific outline of a struct=
ured file that is
+ currently open in the editor area, and lists its structura=
l elements. Right-click on
+ the elements will open additional options that allow addin=
g other specific elements
+ in necessary positions.
+ The Properties view shows property names and their value=
s for a selected item. The
+ values are editable, just select any and click on the butt=
on that appeared to choose
+ a new value. Key combination Ctrl+Z w=
ill return the previous
+ value, Ctrl+Y will return the new val=
ue again. The Properties
+ view has additional options and can be set up to display c=
ategories and advanced
+ properties. It's also possible to use the JBoss Tools
Palette to insert any tag from the list of tag =
libraries to the page you
are editing with just a click or drag-and-drop.
@@ -1160,10 +1092,9 @@
You can insert a tag/component from the palette into ei=
ther the Source or the
Visual part by calling a context menu and selecting Insert
around, Insert before,=
Insert
- after or Replace With,=
pointing to
- From Palette, picking the type of=
the tag and finally
- choosing the tag you want to insert.
-
+ after or Replace With,=
pointing to From Palette, picking the type of the tag =
and finally choosing the
+ tag you want to insert. The image below illustrates how you can insert a tag int=
o the Source part.Inserting a tag into the Source part
@@ -1173,9 +1104,7 @@
-
And this is how a tag is inserted using a context menu i=
n the Visual part.
-
Inserting a tag into the Visual part
@@ -1184,10 +1113,10 @@
- =
- Visual Page Editor also displays custom tags correctly i=
f they are configured properly.
- The picture below shows an example how custom tags "pagination" and =
"echo" will be displayed in VPE.
-
+ Visual Page Editor also displays custom tags correctly i=
f they are configured
+ properly. The picture below shows an example how custom ta=
gs "pagination" and =
"echo" will be di=
splayed in VPE. Custom Tags in the VPE
@@ -1196,21 +1125,19 @@
-
- The listings of the custom tags implementations will help =
to clear how VPE works.
-
- =
-
- echo.xhtml: =
- The listings of the custom tags implementations will he=
lp to clear how VPE works.
+
+
+ echo.xhtml:
+ #{msg}
-]]> =
- =
- paginator.xhtml:
- =
-
+
+
+ paginator.xhtml:
+
@@ -1239,11 +1166,10 @@