JBoss Portal Tools Reference Guide

https://jira.jboss.org/jira/browse/JBDS-1104 - Updated versions,correcte= d master_output file

Modified: trunk/portlet/docs/reference/en/master_output.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/portlet/docs/reference/en/master_output.xml 2010-02-18 09:49:18 U= TC (rev 20353) +++ trunk/portlet/docs/reference/en/master_output.xml 2010-02-18 10:35:18 U= TC (rev 20354) @@ -4,10 +4,12 @@ = [ + - + + = @@ -20,982 +22,1666 @@ = -]> - = - - JBoss Portal Tools Reference Guide - - - - - = - - - = - = - - OlgaChikvina= - SnjezanaPeco= snjezana.peco(a)redhat.com - SvetlanaMukhinasmukhina(a)exadel.com - ThomasHeute= theute(a)jboss.org = - = - September 2008 - - 2008 - 2009 - JBoss by Red Hat - - - Version: 1.1.0.CR1 - - = - - - - - - Introduction - - Starting from 3.0.0.Alpha1 version, JBoss set of plugins extends= JBoss Portal - features. Thus, this guide is intended to explain you how to manag= e the functionality - JBoss Tools provide to = ease the development with JBoss - Portal. - -

- Preface - JBoss Portal provides= an open source platform for hosting and - serving a portal's Web interface, publishing and managing its = content, and customizing - its experience. It supports a wide range of features, includin= g standard portlets, - single sign-on, clustering, and internationalization. -

- -

- Key Features - The next table lists key features supplied by JBoss Portal Tools. - - - Key Functionality of JBoss Portal Tools - - - - - - - - - Feature - Benefit - Chapter - - - - - - - - Wizards for creating Projects with Portl= et Facets - - - New Dynamic Web Project wizard allows yo= u to select a proper - Configuration to enable Portlet Facet in i= t. - - - Creating a Dynamic - Web Project - - - - - - - Create Java Portlet wizard - - - - The wizard enables creating a JSR-186/JS= R-286 compliant - portlet. - - - Adding J= ava Portlet to a - project - - - - - - Create JSF/Seam Portlet wizard - - - This wizard allows to create JSF/Seam po= rtlets - - - Creating JSF Por= tlet - Creating Seam P= ortlet - - - - - -

- -

- Other relevant resources on the topic - - - - - JBoss= Portal Home Page - - - - - - = JBoss Portal Wiki - - - - - - JBoss Tools= Home Page - - - - - - JBoss Tools Forum - - - - - - The latest - JBossTools/JBDS documentation builds - - - - - JBoss Developer Studio/JBoss Tools release documenta= tion you can find athttp://docs= .jboss.org/tools in the corresponding release directory. - - - -

- - - = - - - Installation issues - - This section provides you with the steps on how to start with JBoss - Portal and integrated features using JBoss Tools. - - - - First, you need to have Eclipse Ganymede with JBoss Tool= s 3.0.0.Alpha1 and higher installed. - - - Tip: - Read JBoss Tools - Installation section in our Getting Started do= cumentation to find out - how to install JBoss Tools= onto Eclipse. - - - - - Next, download the JBoss Portal + JBoss AS bundle from <= ulink url=3D"http://www.jboss.org/jbossportal/download/index.html">JBoss Po= rtal Download - page - - - Note: - You need JBoss Portal 2.7 if you want to work with a= Portlet 2.0 - - - - - - Extract the bundle wherever you want on your hard drive<= /para> - - - - Now, when you have it installed, we are going to demonstrate som= e powerful features of - JBoss Portal tooling for Ec= lipse. - - - = - - - Starting the Project with JBoss Portal - - To get started with JBoss Portal and JBoss - Tools, you should first have a Web Project pointed to t= he JBoss Portal Runtime. - Thus, in this chapter we are going to show you how to create a Dyn= amic Web Project, add Java - Portlet to it and deploy it to the JBo= ss Portal. - -

- Creating a Dynamic Web Project - - To create a Dynamic Web Project, go to - File > New > Dynamic Web= Project - if you are in the Web = Perspective or File > - New > Other > Web > Dynamic Web Project in any other Perspective. The - first page of the New Dynamic Web Project wizard looks as foll= ows. - -

- New Dynamic Web Project - - - - - - - - Fill out the name of your project. Next, click the - New - button in the - Target Runtime - section to specify a new Target Runtime. Choose - JBoss Community > JBoss 4.= 2 Runtime - and select the - Create a new local server - checkbox. Click - Next. - -

- New Server Runtime - - - - - - - - On the next page you should give a name to the runtime. Let'= s call it - JBoss Portal 2.7 Runtime - , and then point it to the location of your JBoss A= S + Portal - installation. - -

- New Server Runtime Environment - - - - - - - - - Note: - - The JBoss Tools Portlet feature has been tested using 2.= 6.5 and 2.7.0.ALPHA - versions of JBoss Portal. Remember, if you want to use Portlet - version 2.0 (JSR-268), you have to choose JBoss Portal 2.7= . - - - At this point a new JBoss Server instance will be created. H= ere you can verify the - defined runtime information. If something is incorrect, press = - Back - to return on the previous wizard page. - -

- Target Server - - - - - - - - Click - Finish.<= /para> - - On the next step you should click the - Modify - button next to the Con= figuration section to enable - Portlet Facets for the project. - -

- Setting the Project Configuration - - - - - - - - On this page you should check the - JBoss Core Portlet - and press - OK - . - -

- Enabling the Portlet Facet - - - - - - - - - Note: - If the portlet libraries aren't available in the runtime= you targeted, - JBoss Portlet facets will be hidden on this page. - To made portal functionality always visible no matter wh= at the runtime support, - you should go to - Window > Preferences - and then - JBoss Tools > JBoss Por= tlet - and deselect - Check runtimes for Portlet= Components - checkbox (see figure below). - - -

- JBoss Runtime Preferences - - - - - - - - The next page is for configuring web modules. Here all value= s are set, so you can - leave everything as it is. - -

- The Project Web Modules - - - - - - - - Finally, the last wizard page will ask you to add JBoss Port= let capabilities to your - project. Here you can choose whether to set up user libraries,= libraries provided by - server runtime or not include libraries at all. - = - - To set up server runtime libraries, you need t= o select - Libraries provided by server r= untime in the list box. - - - = -

- Including Server Runtime Libraries - - - - - - - - - - For setting up user libraries, select - User library in the list box and then press - Add = in the - User Library section. - - - = -

- Adding User Library - - - - - - - = - Then press - New and type= the user library name in the appeared dialog. - = -

- Adding User Library - - - - - - - = - Next add necessary jar's. - = -

- Adding the Portlet API Jar - - - - - - - = - Hit - OK. The = user library will be added. - - = -

- User Library Added - - - - - - - = - - If you don't need to include libraries at all,= just deselect the - Enable implementation library<= /property> checkbox. - - - = -

- Disabling Implementation Libraries - - - - - - - = - After setting JBoss Portlet capabilities press - Finish. - - That's it! Our base project is done. - -

- -

- The Project Structure Overview - - Now, let's look at the structure of the just created project= . - -

- The Project Structure Overview - - - - - - - - Here JBoos Tools adde= d JBoss Portlet facet to the project, - created an empty - portlet.xml - file and added the Portlet library to the project = classpath. -

- -

- Adding a Java Portlet to the Project - - At this point we'll show what the steps you need to proceed = to add a new Java - Portlet to the project. - - Call the Create Portlet wizard by selecting - New > Other > JBoss Tool= s Web > Portlet > Java - Portlet. - -

- New Java Portlet - - - - - - - - The wizard fills in the Web Project and Source Folder fields= for you. Then you need to - specify the Java package and the Class name and click - Next - . - -

- Specifying Class File Destination - - - - - - - - On the other page you will be able to set the display name o= f the Portlet, a title, a - description, the supported modes and init parameters. - -

- Specifying Class File Destination - - - - - - - - On the next screen you can define which methods from - GenericPortlet you want to override.<= /para> - -

- Specifying Class File Destination - - - - - - - - The last screen lets you build J= Boss Portal specific descriptors - to create an instance during the deployment and place it direc= tly on the Portal. - -

- Specifying Class File Destination - - - - - - - - - Tip: - - If you uncheck the Create Portlet Instance checkbox, - JBoss Tools won= 't create the deployment elements - in the default-object.xml and - portlet-instances.xml files. - - - Once Java Portlet is created, new resources have been added = to the project structure. - As you can see on the figure below, it adds a Java Portlet cla= ss ( - TestPortlet.java - in our case), - default-object.xml - and - portlet-instances.xml - files and updates - portlet.xml - as well. - -

- The structure of Web Project with Java Portlet created<= /title> - <mediaobject> - <imageobject> - <imagedata fileref=3D"images/starting_project/starting= _project_12.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Thus, now the Project is ready to be built and deployed.</pa= ra> - </section> - - <section id=3D"deploying_to_portal"> - <title>Deploying a Portlet to JBoss Portal - - You can deploy the created project in the way you deploy any= other Web Application. - Right click on the project and do - Run As > Run On Server - and accept the defaults. On the - Add and Remove Projects - page move the created Project to the right and cli= ck - Finish.<= /para> - -

- Deploying the Portlet Application - - - - - - - - It will deploy the Portlet Web Application and start JBoss - AS. - - - Tip: - - You should use http://localhost:8080/portal URL to see your - Portlet in the Browser. - - - In the Browser the Portlet looks as follows: - -

- Java Portlet in the Browser Window - - - - - - - - Consequently, here you learnt how to create a Dynamic Web Pr= oject, add Java Portlet to - it and deploy the project to JBoss= Portal. -

- - - - = - - - Creating JSF Portlet - - This chapter will explain how you can configure JSF Portlet with= in Dynamic Web - Project and JSF Project by using the wizards JBoss Tools provides. - -

- Adding JSF Portlet to Dynamic Web Project - = - To add JSF Portlet to a Dynamic Web Project, you should set = the Configuration to - JavaServer Faces v1.1 Project - or - JavaServer Faces v1.2 Project - and configure the JSF Portlet Facets in the New Dynamic Web - Project wizard by clicking the - Modify - button. - = -

- Setting the JSF Configuration - - - - - - - = - On the Project Facets dialog you should select JBoss Core Portlet - and JBoss JSF Portlet c= heck boxes. - = -

- Enabling the Portlet Facets - - - - - - - = - Next wizard page is for configuring JSF Capabilities. You ca= n leave everything as it - is here. - = -

- JSF Capabilities - - - - - - - = - To support Portlets in JSF/Seam applications JBoss Tools works - with JBoss Portlet Bridge. Thus on the next page you should add JSF Portlet - capabilities by pointing to the Portletbridge Runtime location= . - = -

- JSF Capabilities - - - - - - - = - - Tip: - = - You can download JBoss Portlet Bridge 1.0.0.B4 from Portletbridge Downl= oad page. - - = - Next click - Finish - to organize the Project. - To add JSF Portlet to generated proje= ct you should call the - Create Portlet wizard b= y navigating to - New > Other > JBoss Tool= s Web > Portlet > JSF/Seam - Portlet. - = -

- Calling New Portlet Wizard - - - - - - - = - As you see, the Seam and JSF Portlet wizards are merged into= one. We set JSF - Configuration for the project, so default values in this wizar= d will be set as for a JSF - portlet. - = -

- Creating JSF Portlet - - - - - - - = - Click - Finish - to complete JSF Portlet creation. Now you can deploy t= he project the same - way as it was described = above. - = - In the Browser JSF Portlet looks as follows. - = -

- JSF Portlet in the Browser - - - - - - -

- -

- Adding JSF Portlet to JSF Project - = - How to organize a JSF Project you can find out in our J= SF Tools Reference Guide. Just - remember to point Target Runtime to JBoss Portal directory loc= ation. - = -

- Creating New JSF Project - - - - - - - = - Before adding a Portlet to the project you should enable nec= essary facets for it. - Right-click the created project and click - Preferences - to open the Project Pr= eferences screen. - On the Project Facets= page select the - JBoss Core Portlet - and - JBoss JSF Portlet - checkboxes. And then the screen will ask you to enable= - JavaServer Faces - facet as well. - = -

- Project Facets - - - - - - - = - Notice, - "Further configuration required...= " - warning appears at the bottom of the screen. It means = that you should click - it to configure JSF and JSF Portlet Capabilities in the projec= t. - = -

- JSF Capabilities - - - - - - - = -

- Project Facets - - - - - - - = - After setting the path to Portletbridge Runtime location, cl= ick - OK - and then - OK - again. - = - Now you can add JSF Portlet to the generated JSF Project. Ho= w to do it we showed in - the previous section.= -

- - - = - - - Creating Seam Portlet - - This chapter covers the steps on how to configure Seam Portlet w= ithin Dynamic Web - Project and Seam Project by using the wizards JBoss Tools provides. - = -

- Adding Seam Portlet to Dynamic Web Project - - To add Seam Portlet to a Dynamic Web Project first you shoul= d organize New Dynamic Web - Project with the Configuration setting to - JBoss Seam Portlet Project v2.= 0. - -

- Calling New Portlet Wizard - - - - - - - - It will add all needed facets to your project. By clicking t= he - Modify - button you can observe the chosen configuration of= facets as well as modify - it. As you can see, all JBoss Portlets are checked. - -

- Project Facets - - - - - - - - Next wizard pages are for adjusting the Project Web Modules = and JSF Configuration. - They include default values, so you can skip them by pressing = - Next. - - On the Seam Facet pag= e set - Connection Profile and hit - Next. - -

- Seam Facet Settings - - - - - - - - Last wizard page will prompt you to set the path to Portletb= ridge Runtime - location. - -

- Setting the Portletbridge Runtime - - - - - - - - - Tip: - - Thus you should have JBoss Portlet Bridge downloaded and= extracted somewhere on - your hard drive. You can download JBoss Portlet Bridge 1.0= .0.B4 from www.= jboss.org/portletbridge/download. - - - Now, to add Seam Portlet to the project you should follow to= - New > Other > JBoss Tool= s Web > Portlet > JSF/Seam - Portlet. This will call the wizard f= or creating JSF/Seam - Portlets. - -

- Calling the Create Portlet Wizard - - - - - - - - As we set Seam Configuration for the Dynamic Web Project, th= e wizard puts the values - as for Seam Portlet. - -

- Creating Seam Portlet - - - - - - - - After creating the Seam Portlet, you should deploy - the project to JBoss Portal and start the Server. I= n a Browser - you'll see the following: - -

- Seam Portlet in the Browser - - - - - - -

- = -

- Adding Seam Portlet to Seam Project - = - First start a Seam Project by following to - New > Other > Seam > Seam= Web Project. On the first - wizard page specify JBoss Portal directory location as Target - Runtime and - JBoss Seam Portlet Project= v2.0 - as Configuration. - = -

- Project Facets - - - - - - - = - Next steps will be the same as we did for the Dynamic Web Pr= oject in the Adding Seam Portlet to Dynamic= Web Project - section. -

- - - = - - - Adding Portlets to non-WTP Projects - - Starting from JBoss Tools 3.0.0.Beta= 1 version the JBoss Portlet - wizards no longer require a WTP project to be able to create Portl= ets. - - - Note: - Please note, if the project does not have the proper portlet= API jar's, the generated - classes will have compile errors. - - - In conclusion, with this document you've learnt how to get start= ed with JBoss - Portal using JBoss Tools suite of Eclipse plugins. - The above chapters walked you through the steps on how to organize= a web project with - portlets which includes a sample staff and deploy it onto the JBoss - Portal. - = - If you still have questions or suggestions you are always welcom= e on our Forum. Your feedback will be very much ap= preciated. - = - - - = - +]> + = + + <diffmk:wrapper diffmk:change=3D"changed">JBoss Portlet To= ols User Guide</diffmk:wrapper> + + + + + = + + + = + = + + OlgaChikvina= + SnjezanaPeco= snjezana.peco(a)redhat.com + SvetlanaMukhinasmukhina(a)exadel.com + ThomasHeute= theute(a)jboss.org = + = + + 2008 + 2009 + 2010 + JBoss by Red Hat + + + Version: 1.1.0.CR2 + + = + + + + + + Introduction + + Starting from 3.0.0.Alpha= 1 version, JBoss set of plugins includes tools for supporting JBoss Portal and JSR-186/JSR-286 portlets. + Thus, this guide is intended to explain you how to get started and manag= e JBoss Portlet Tools. + +

+ <diffmk:wrapper diffmk:change=3D"changed">What is JBoss Por= tal and Portlet Tools?</diffmk:wrapper> + JBoss Portal provides an open source platform for hostin= g and + serving a portal's Web interface, publishing and managing its = content, and customizing + its experience. It supports a wide range of features, includin= g standard portlets, + single sign-on, clustering, and internationalization. More abo= ut JBoss Portal you can find visiting = + its home page at: http://www.jboss.org/jbossportal/. + = + With = JBoss Portlet Tools you can easily create = a Java, JSF and Seam portlet and deploy it to JBoss Portal. +

+ +

+ <diffmk:wrapper diffmk:change=3D"changed">Key Features of JBos= s Portlet Tools</diffmk:wrapper> + JBoss Portlet Tools supports = the JSR-168 = Portlet Specification (Portlet 1.0) and + JSR-2= 86 Portlet Specification (Portlet 2.0) and works with = + JBoss Portl= et Bridge = for supporting Portlets = + in JSF/Seam applications. To enable these features, you need to add = the JBoss Portlet facet to a new or an existing web project = + (see JBoss Portlet Tools= Tasks). Th= e project could be a non-WTP project, but you should know that = + if it does not have the proper portlet API jar's the generated class= es will have compile errors. + = + The next table lists key features supplied by JBoss Portlet Tools. + + + <diffmk:wrapper diffmk:change=3D"changed">Key Features of = JBoss Portlet Tools</diffmk:wrapper> + + + + + + + + + Feature + Benefit + Chapter + + + + + + + + J= Boss Portlet facets + + + JBoss Portlet Tools provides the= Java, JSF and Seam Portlet facets that could be enabled for a Web project.= + + + JBoss P= ortlet Tools Tasks + + + + + + J= ava Portlet wizard + + + + The wizard helps create a JSR-186/JSR-286 compliant + portlets + + + Java Po= rtlet Wizard + + + + + + J= SF/Seam Portlet wizard + + + This wizard helps create JSF/Seam portlets + + + JSF/Seam Portlet W= izard + + +

+ Requirements and Installation + = + JBoss + Portlet Tools needs the following minimal requirements: + = + + + Eclipse 3.4.2/Ganymede + + + JBoss Tools 3.0.0.Alph= a1 (for higher versions of JBoss Tools make sure you use the = + compatible= version of Eclipse) + + JDK 5 or higher= + + JBoss Portal + JBoss A= S bundle from: http://w= ww.jboss.org/jbossportal/download/index.html + + Note: + JBoss Portlet Tools has= been tested using 2.6.5 and 2.7.0.ALPHA + versions of JBoss Portal. Remember, if yo= u want to use Portlet + version 2.0 (JSR-268), you have to choose JBoss Portal 2.7. + + + + JBoss Portlet Bridge (op= tionally) from: http://www.jboss.org/portletbridge/downloads.html + + + + JBoss Portlet Tools is included as part of JBo= ss Tools project. = + Refer to http://www.jboss.org/tools/download/installation.html = + for installation methods of JBoss Too= ls. +

= + + + + JBoss Portlet Tools Tasks +

+ Creating and Deploying a Java Portlet + = + This chapter shows how to create a Dynamic Web Project, add a Java + Portlet to it and deploy it to the JBoss Portal. + = +

+ Creating a Web Project with JBoss Portlet Capabilities + Fallow the next procedure to create a Web project with JBoss Port= let capabilities pointed to the JBoss Portal runtime. + = + + + Go to + File > New > Dynamic Web Project + if you are in the Web perspective or= File > + New > Other > Web > Dynamic Web Project in any= other perspective. = + The New Dynamic Web Project wizard appears. + = +

+ New Dynamic Web Project + + + + + + + + = + Specify the name of the project. + = + + Click + New + in the + Target Runtime + area to create a JBoss Portal runtime. Choose + JBoss Community > JBoss 4.2 Runtime + and select the + Create a new local server + check box below. Click + Next. + = +

+ New Server Runtime + + + + + + + + = + + The New Server Runtime Environment wizard = appears. In the + Name field, type + JBoss Portal 2.7 Runtime, + and then use the + Browse button to point to the locat= ion of JBoss Portal + JBoss AS extracted. Click + Next to proceed. + = +

+ New Server Runtime Environment + + + + + + + + = + + At this point a new JBoss Server instance will be created. On t= he next page you can verify the + runtime information defined. If something is incorrect, press + Back + to return to the previous wizard page. Click + Finish. + = +

+ Target Server + + + + + + + + = + + Click + Modify + in the Configuration area to enable + a portlet facet for the project. + = +

+ Setting the Project Configuration + + + + + + + + = + + In the Project Facets dialog, check + JBoss Core Portlet + and press + OK + . + = +

+ Enabling the JBoss Core Portlet Facet + + + + + + + = + + Note: + If the portlet libraries aren't available in the runtime = you targeted, + + JBoss Portlets facets will be hidd= en on this page. + To make them always visible no matter what the runtime is set,= you should enable the appropriate option in = + JBoss Portlet Preferences. + + + = + + The Java and Web Module pages are for configuring Java and Web modules in the project. = + Here all values are set, so leave everything as it is. + + = + + The last wizard page will ask you to add JBoss Portlet capabili= ties to the + project. Select + Portlet Target Runtime Provider and= click + Finish to complete the project cre= ation. + = +

+ Including the Portlet Libraries Provided by Target Runtime</t= itle> + <mediaobject> + <imageobject> + <imagedata fileref=3D"images/starting_project/portlet_capabilities= 6.png"/> + </imageobject> + </mediaobject> + </figure> + = + <note> + <title>Note: + All types available under + Portlet Implementation Library are = fully described in the Wiki article at: = + http://www.jboss.org/community/wiki/PortletFacetLibraries. + + + + = + As the result, JBoss Portlet Tools adds + JBoss Core Portlet facet to the projec= t, + creates an empty portlet.xml file and adds the JBos= s Portlet library to the project classpath. + = +

+ Portlet Project Structure Overview + + + + + + +

+ = +

+ Adding a Java Portlet to a Web Project + = + At the previous section you have created a web project with JBoss= Portlet capabilities. = + The next steps will show you how to add a new Java portlet to the proj= ect. + = + + = + Right-click the project and follow to + New > Other > JBoss Tools Web > Portlet > Java + Portlet. + = +

+ New Java Portlet + + + + + + + + = + + The Create Portlet wizard starts (for info= rmation about the wizard options, see = + "Java Portlet Wizard"= ; in the guide reference). = + The wizard fills in the Project and + Source Folder fields for you. You s= hould specify a Java package and a class name = + (for instance, + org.example and + TestPortlet). Then click + Next + . + = +

+ Specifying Class File Destination + + + + + + + + = + You may leave the next three pages with default values= , on the last one hit + Finish. + + + = + Once a Java portlet is created, new resources are added to the pr= oject structure: a Java portlet class (TestPortlet.java)= , = + default-object.xml and portlet-instances.x= ml files and the portlet.xml descriptor is upd= ated as well. + = +

+ Structure of the Project with a Java Portlet + + + + + + + = + Thus, now the project is ready to be built and deployed. +

+ = +

+ Deploying a Portlet to JBoss Portal + = + You can deploy a portlet project in the way you deploy any other = web application. + = + + + Right-click the project and do + Run As > Run On Server. + The Run On Server wizard starts. + = +

+ Running the Java Portlet on Server + + + + + + + + = + + Select JBoss Portal 2.7 Server created before and click Next. + + = + + On the + Add and Remove + page move the created project to the right and click + Finish. + = +

+ Deploying the Portlet Application + + + + + + + = + It will deploy the portlet application and start JBoss + AS. + + = + + Use the http://localhost:8080/portal/portal/default/d= efault URL to see your + portlet in the browser. + = +

+ Java Portlet in the Browser Window + + + + + + + + +

+ = +

+ <diffmk:wrapper diffmk:change=3D"added">Cr= eating and Deploying a JSF Portlet</diffmk:wrapper> + + = This chapter will explain how you can configure a JSF portlet within a JSF = project with JBoss Portlet capabilities = + and then deploy it to JBoss Portal<= /diffmk:wrapper>. + +

+ <diffmk:wrapper diffmk:change=3D"added= ">Creating a JSF Project with JBoss Portlet Capabilities</diffmk:wrapper></= title> + = + <para diffmk:change=3D"added"><diffmk:wrapper diffmk:change=3D"add= ed">You can create a JSF project with JBoss Portlet capabilities in two way= s:</diffmk:wrapper></para> + = + <orderedlist continuation=3D"restarts" diffmk:change=3D"added" inheri= tnum=3D"ignore"> + <listitem diffmk:change=3D"added"> + <para><diffmk:wrapper diffmk:change=3D"added">Create a dynamic Web = project with the </diffmk:wrapper><emphasis diffmk:change=3D"added"><proper= ty moreinfo=3D"none"><diffmk:wrapper diffmk:change=3D"changed">JavaServer F= aces</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change=3D= "added"> + and </diffmk:wrapper><emphasis><property moreinfo=3D"none"><diffmk= :wrapper diffmk:change=3D"changed">JBoss JSF Portlet</diffmk:wrapper></prop= erty></emphasis><diffmk:wrapper diffmk:change=3D"added"> facets enabled ( + </diffmk:wrapper><link diffmk:change=3D"added" linkend=3D"create_d= yn_web_proj_jsf"><diffmk:wrapper diffmk:change=3D"added">the steps to proce= ed</diffmk:wrapper></link><diffmk:wrapper diffmk:change=3D"added">)</diffmk= :wrapper></para> = + </listitem> + <listitem diffmk:change=3D"added"><para diffmk:change=3D"added"><dif= fmk:wrapper diffmk:change=3D"added">Or create a JSF project using the wizar= d JBoss JSF Tools provides, then enable = + JSF and JBoss Portlet facets and add JBoss Portlet capabilities ( + </diffmk:wrapper><link diffmk:change=3D"added" linkend=3D"create_js= f_proj"><diffmk:wrapper diffmk:change=3D"added">the steps to proceed</diffm= k:wrapper></link><diffmk:wrapper diffmk:change=3D"added">)</diffmk:wrapper>= </para></listitem> + </orderedlist> + = + <para diffmk:change=3D"added"><diffmk:wrapper diffmk:change=3D"added"= >Refer to the further sections for the procedures on how to do this.</diffm= k:wrapper></para> + = + <section diffmk:change=3D"added" id=3D"create_dyn_web_proj_jsf"> + <title><diffmk:wrapper diffmk:change=3D"changed">Creating a Dynamic = Web Project with the JBoss Portlet Capabilities</diffmk:wrapper> + = + The basic steps to c= reate a dynamic Web project with the JBoss Portlet capabilities are as foll= ows: + = + + + Start the Dynamic Web Project wizard navigati= ng to + File > New > Other > Web > Dyna= mic Web Project. + = + + <diffmk:wrapper diffmk:change=3D"a= dded">Tip:</diffmk:wrapper> + You can also select the Java EE perspectiv= e and then go to = + File > New > Dynamic Web Project. + + = +

+ <diffmk:wrapper diffmk:change=3D"changed">Setting the JSF = Configuration</diffmk:wrapper> + + + + + + + + = + + Specify the project name and set the target runtime to JBoss Portal by following the points 3, 4 and 5 in the = + "Creating a Web Projec= t with JBoss Portlet Capabilities" procedure. + + = + + In the Configuration + area, click Modify and enable JavaServer Faces<= diffmk:wrapper diffmk:change=3D"added">, + JBoss Core Por= tlet and JBoss JSF Portlet facets. + Hit OK. + = +

+ <diffmk:wrapper diffmk:change=3D"changed">Enabling the Por= tlet Facets</diffmk:wrapper> + + + + + + + + = + + You may leave the next two wizard pages with defaults, just press Next to = proceed. + + = + + On the JBoss Portlet Capabilities= page, select + Portlet Target Runtime Provider= and click Next. + = +

+ <diffmk:wrapper diffmk:change=3D"changed">JBoss Portlet Ca= pabilities</diffmk:wrapper> + + + + + + + = + + <diffmk:wrapper diffmk:change=3D"a= dded">Tip:</diffmk:wrapper> + All types of the po= rtlet implementation library are described more closely in the wiki article= at: = + http://www.jboss.org/community/wiki/PortletFacetLibraries. + + + = + + Next wizard page is for configuring JSF capabilities. You can leave eve= rything as it + is here. + = +

+ <diffmk:wrapper diffmk:change=3D"changed">JSF Capabilities= </diffmk:wrapper> + + + = + + + + + = + + On the J= Boss JSF Portlet Capabilities page, select = + JSF Portlet Target Runtime Provider as the JSF portlet implementatio= n library. It will + copy Portlet Bridge libraries from the server runtime to the proj= ect classpath. + = +

+ <diffmk:wrapper diffmk:change=3D"changed">JBoss JSF Portle= tCapabilities</diffmk:wrapper> + + + + + + + = + + Tip: + On this page, it = is also possible to add the RichFaces libraries from the RichFaces distribu= tion by checking = + Add/Change Richfaces Libraries.<= /emphasis> + + = + + <diffmk:wrapper diffmk:change=3D"a= dded">Note:</diffmk:wrapper> + You can select the JSF Po= rtletbridge Runtime Provider type. Then it = + is necessary to set the home of the Portlet Bridge distribution.<= /diffmk:wrapper> + For information about all the JSF Portlet facet library providers, ref= er to the wiki article at: = + http://community.jboss.org/wiki/PortletFacetLibraries. + + + = + + Click Finish. The project will be creat= ed in the workbench. + + +

+ = +

+ <diffmk:wrapper diffmk:change=3D"adde= d">Creating a JSF Project and adding the JBoss Portlet Capabilities</diffmk= :wrapper> + = + How to organize a JSF project you can find out in the JSF Tool= s User Guide. Just + remember to point the target runtime to JBoss Portal directory location (see = + how it is done for a dynamic Web project: steps 3, 4 and 5 in the = + "Creating a Web Project = with JBoss Portlet Capabilities" procedure). + = +

+ <diffmk:wrapper diffmk:change=3D"add= ed">Creating New JSF Project</diffmk:wrapper> + + + + + + + = + To add the JBoss Portlet capabilities to the created JSF project you shou= ld complete the next steps: + = + + + Right-click the pr= oject and click + Properties + to open the pr= oject = Properties sheet. Select = Project Facets + on the left and enable the JavaServer Faces= , + JBoss Core Portlet and JBoss JSF= Portlet facets. + = +

+ <diffmk:wrapper diffmk:change=3D"changed">Project Facets</= diffmk:wrapper> + + + + + + + + = + + Notice, + "Further configuration available..." + warning appear= s at the bottom of the screen. It means that next you should configure the = JSF Portlet capabilities in the project. = + Click the link. The Modify Face= ted Project wizard appears. + + = + + Complete all wizard = pages the same way as described in the steps 5, 6, 7 of the = + "Creating a Dynamic We= b Project with the JBoss Portlet Capabilities" procedure. + Hit OK. + + = + + To apply the changes click Apply= and then = + OK to close the project <= property diffmk:change=3D"added" moreinfo=3D"none">Properties sheet. + + +

+ +

+ <diffmk:wrapper diffmk:change=3D"ad= ded">Adding a JSF Portlet to the Project and Deploying It to JBoss Portal</= diffmk:wrapper> + = + The previous section has shown how to create a JSF project with JBoss P= ortlet and JSF Portlet capabilities enabled. Use = + the following procedure to add a JSF portlet to the created projec= t and deploy it to JBoss Portal. + = + + + Call the + Create Portlet<= /property> wizard by navigating to = + New > Other > JBoss Tools Web > Portlet= > JSF/Seam + Portlet on the context menu of the project (for information a= bout the wizard options, see = + "JSF/Seam Portlet = Wizard" in = the guide reference). + = +

+ <diffmk:wrapper diffmk:change=3D"changed">Calling New Portl= et Wizard</diffmk:wrapper> + + + + + + + = + + Tip: + As you see, the JSF and Seam Portlet wizards are merged into one. We ha= ve set the JSF + configuration for the project, so the default values in this wiza= rd will be set as for a JSF + portlet. + + + = + + Leave all the wizard = pages with default values by clicking the Next button, = + on the last one click = Finish to complete the JSF portlet creation. + + = + + Complete the steps de= scribed in the "Deploying a Por= tlet to JBoss Portal" procedure to + deploy a JSF portlet to JBoss Por= tal. Ju= st use the other URL to see it in the browser: = + http://localhost:8080/portal/portal/default/JSFPor= tlet. + = +

+ <diffmk:wrapper diffmk:change=3D"changed">JSF Portlet in th= e Browser</diffmk:wrapper> + + + + + + + + + +

+ + + = +

+ <diffmk:wrapper diffmk:change=3D"changed">Creating and Deploying a= Seam Portlet</diffmk:wrapper> + + This chapter covers th= e steps on how to configure a Seam portlet within a Seam + project with the help of the JBoss Portlet Tools features= . + = +

+ <diffmk:wrapper diffmk:change=3D"changed">Creating a Seam Proj= ect with JBoss Portlet Capabilities</diffmk:wrapper> + + Follow one of two ways of = creating a Seam project with JBoss Portlet capabilities enabled: + + + Create a dynamic Web project with the Seam + and JBoss Portlets facets enabled (the steps to proceed) = + + Or create a Seam project with the JBoss= Seam portlet configuration using the wizard JBoss Seam Tools provides = + and follow all the wizard steps to enable JBoss Portlet capabilitie= s (the steps to proceed) + + = +

+ <diffmk:wrapper diffmk:change=3D"adde= d">Creating a Dynamic Web Project with Seam and JBoss Portlet Capabilities<= /diffmk:wrapper> + = + To create a dynamic Web project with Seam and JBoss Portlet capabilities = you should take the following steps: + = + + + In the File menu, go = to = + New > Other > Web > Dynamic Web Pr= oject= . The <= /diffmk:wrapper>New Dynamic Web Project + wizard starts. + = +

+ <diffmk:wrapper diffmk:change=3D"changed">Creating a New D= ynamic Web Project</diffmk:wrapper> + + + + + + + + = + + Give the project a name and follow the steps 3, 4, 5 of the = + "Creating a Web Projec= t with JBoss Portlet Capabilities" procedure to set the target runtime. + + = + + In the Configuration<= /emphasis> area of the first wizard= page, = + select + JBoss Seam Portlet Project v2.0. It will add needed facets to the project. + = + + <diffmk:wrapper diffmk:change=3D"a= dded">Tip:</diffmk:wrapper> + If you now click the Modify button, you should see the = + JavaServer Faces, Jboss Portlets + and Seam facets enabled. + + = +

+ <diffmk:wrapper diffmk:change=3D"changed">Project Facets</= diffmk:wrapper> + + + + + + + + = + + The next two pages a= re for adjusting the project Java and Web modules. + They include the default values, so you can skip them by pressing= + Next. + + = + + On the Jboss Portlet Capabilities page, sele= ct = + Portlet Target Runtime Provider as the portlet implementation library= . + = + + <diffmk:wrapper diffmk:change=3D"a= dded">Tip:</diffmk:wrapper> + All types of the portlet implementation library are described more clo= sely in the wiki article at: = + http://www.jboss.org/community/wiki/PortletFacetLibraries. + + + = + + The next page is for configuring JSF capabilities. As it contains the d= efault values, just click + Next to proceed. + + = + + On the Seam Facet page, set a Seam runtime a= nd + a connection profile. + = + + <diffmk:wrapper diffmk:change=3D"a= dded">Tip:</diffmk:wrapper> + For details about how to set a Seam runtime and a connection profile, = see = + "Configure Seam Facet Settings" in the Chapter 2, = + "Seam Dev= Tools Reference Guide". + + = +

+ <diffmk:wrapper diffmk:change=3D"changed">Seam Facet Setti= ngs</diffmk:wrapper> + + + + + + + + = + + On the JBoss JSF Portlet Capabilities page, select the = + JSF Portlet Target Runtime Provider type of the implementation libra= ry. + = + + <diffmk:wrapper diffmk:change=3D"a= dded">Tip:</diffmk:wrapper> + If you have JBoss Portlet= Bridge downloaded, = + alternatively you can select JSF Portletbridge Runtime Provider and= then provide a path to + the JBoss Portlet Bridge distributio= n. + + = +

+ <diffmk:wrapper diffmk:change=3D"changed">Setting Portlet = Bridge Provider</diffmk:wrapper> + + + + + + + = + It will add JBoss Portlet Bridge<= diffmk:wrapper diffmk:change=3D"added"> libraries to the project classpath.= + + = + + Hit Finish to complete the project creation. + + +

+ = +

+ <diffmk:wrapper diffmk:change=3D"adde= d">Creating a Seam Project with JBoss Portlet Capabilities</diffmk:wrapper>= + = + The steps to create a Seam project with JBoss Portlet capabilities are as= follows: + = + + + In the File menu, go = to + New > Other > Seam > Seam Web Project. The New Seam Project + wizard appears. + + = + + Next steps are the same as in the "Creating a Dynamic Web Project with Seam and JBoss Portlet Ca= pabilities" + procedure starting from the step 2. + + +

+ = +

+ <diffmk:wrapper diffmk:change=3D"added= ">Adding a Seam Portlet to the Project and Deploying It to JBoss Portal</di= ffmk:wrapper> + = + The previous section has shown you how to create a Web project with Seam a= nd JBoss Portlet capabilities. Now you can create a Seam portlet = + and deploy it to JBoss Portal by followin= g the next procedure: + = + + + In the File or context menu of the project go to = + New > Other > JBoss Tools Web > Portlet > JSF/Seam + Portlet. + = +

+ <diffmk:wrapper diffmk:change=3D"changed">Calling the Cr= eate Portlet Wizard</diffmk:wrapper> + + + + + + + + = + + The Create Portlet wizard starts (for more information about wizar= d options, see = + "JSF/Seam Portl= et Wizard" = in the guide reference). = + As the Seam configuration is set for the project, the wizard pu= ts the values as for Seam portlet. + = +

+ <diffmk:wrapper diffmk:change=3D"changed">Creating Seam = Portlet</diffmk:wrapper> + + + + + + + + = + + Next two pages a= re filled out with default values, just press Next to + proceed. On the last one click Finish<= diffmk:wrapper diffmk:change=3D"added"> to complete. + + = + + To deploy and run the portlet on JB= oss Portal complete the steps described in the = + "Deploying a Portlet to JBoss Portal" procedure. Jus= t use the following URL to see it in the browser: + http://localhost:8080/portal/portal/default/Sea= mPortlet. + = +

+ <diffmk:wrapper diffmk:change=3D"changed">Seam Portlet i= n the Browser Window</diffmk:wrapper> + + + + + + + + +

+ + + + Reference + = + This chapter includes detailed reference information about JBoss Portlet Tools. +

+ JBoss Portlet Descriptors + = + In order to a web project with portlets could be deployed to JBoss Portal, it should include certain descriptors. + The next table lists and describes these configuration files. + = + + JBoss Portlet Descriptors = + + + + Name + = + Description + + + + + portlet.xml + The mandatory portlet descriptor defined by the JSR-168 Portlet Specification. + It is used during deployment. + = + = + + portlet-instances.xml + The optional JBoss Portal specific descr= iptor. It allows to create a portlet instance from a portlet class definiti= on. + = + = + + *-object.xml + The optional JBoss Portal specific descr= iptor. It helps define the layout of the portal. + = + = + + jboss-portlet.xml + The optional JBoss Portal specific descr= iptor. It allows to use JBoss = + specific functionality within a portlet application. + = + + +

+ = + For more detail information about each descriptor, see = + "Portlet Descriptors" in Ch= apter 6, + "JBoss Portal Reference Guide". +

+ = +

+ Wizards + This section describes the JBoss Portlet Tools wizards: + + Java Portlet wiza= rd + JSF/Seam Port= let wizard + + = +

+ Java Portlet Wizard + = + The Java Portlet wizard helps you create a n= ew Java portlet (1.0 or 2.0). It is based on the WTP's Create Servlet wizar= d, = + but adapted to JBoss Portlet. You can call it from the File or context menu of your project by followin= g to = + New > Other > JBoss Tools Web > Portlet &g= t; Java Portlet. + = + The wizard consists of the four pages: + = + + + The first one includes the next options to adjust: + = + + Java Portlet Wizard. First Page Options. = + + + + + = + + + Option = + Description + Default + + + + + Project + Select the project to add a new Java portlet + The project selected when the wizard has been started + = + = + + Source folder + The path to the source folder relative to the selected pro= ject + The source folder of the project selected in the Project field + = + = + + Java package + Enter a package to contain a new portlet. Either type a va= lid package name or click = + Browse to select a pac= kage via the dialog box. + <blank> + = + = + + Class name + Type a name for a new Java portlet class + <blank> + = + = + + Superclass + Type or click Browse to select a superclass for a Java portlet class + javax.portlet.GenericPortlet + = + = + + Use an existing Portlet class + Select this check box if you want to use an existing Java = portlet class. In the appeared = + Class name field type = or = + click Browse to select= an existing portlet class. + Cleared + = + + +

+ + = + + The second wizard page is for specifying modifiers, interfaces = to implement and method stubs to generate. + = +

+ Second Page of the Java Portlet Wizard + + + + + + + = + The descriptions of the options listed on this page are in the = following table. + = + + Java Portlet Wizard. Second Page Options. = + + + + + = + + + Option = + Description + Default + + + + + Modifiers + Select one or more access modifiers for a new Java portlet= class: + + Public + Abstract + Final + + + Public + = + = + + Interfaces + Click Add to cho= ose interfaces that a new class implements + <blank> + = + = + + Which method stubs would you like to create? + Choose which methods from superclass to override in the Ja= va portlet class: + + Constructors from superclass + Inherited abstract methods + init + doView + doDispatch + destroy + doEdit + processAction + getPortletConfig + doHelp + render + + + Inherited abstract methods, doView + = + + +

+ + = + + The third page is for adjusting the portlet deployment descript= or settings. + = +

+ Third Page of the Java Portlet Wizard + + + + + + + = + + Java Portlet Wizard. Third Page Options. = + + + + + = + + + Option = + Description + Default + + + + + Name + Enter the portlet name. It does not have to be the portlet= class name. + The name of the portlet class + = + = + + Display name + Enter the display name of the Java portlet + The name of the portlet class + = + = + + Title + Enter the title of the portlet + The name of the portlet class + = + = + + Description + Enter the description of the portlet's function + <blank> + = + = + + Portlet Modes + Select one or more of three modes defined by the JSR-286 s= pecification: = + + View - generates markup r= eflecting the current state of the portlet; + Edit - allows customizing= the behavior of the portlet; + Help - provides an inform= ation on how to use the portlet. + + + View + = + = + + Initialization Parameters + Specify initialization parameters to create an initial sta= te inside your portlet class. Click = + Add and fill in the = + Name, Value and + Description (optional) = fields to set a parameter. + <blank> + + + +

+ = + + = + + The last wizard page helps configure the JBoss Portlet specific= descriptors. + = +

+ Last Page of the Java Portlet Wizard + + + + + + + = + + Java Portlet Wizard. Last Page Options. = + + + + + = + + + Option = + Description + Default + + + + + Create Portlet Instance + Clear the Create Portlet Instance check box, + if you don't wont the wizard to create the deployment eleme= nts + in the default-object.xml and + portlet-instances.xml files + Selected + = + = + + If Exists + Select one of two options: + + overwrite - destroys the e= xisting object and creates a new one based on the content of the deployment= + keep - maintains the exist= ing object deployment or creates a new one if it does not exist + + + overwrite + = + = + + Instance Name + Enter a name of the portlet instance that the portlet wind= ow represents + [Portlet class name]Instance + = + = + + Page Name + If set, the portlet page is created with the name defined<= /entry> + <blank> + = + = + + Window Name + Enter a name of the portlet window + [Portlet class name]Window + = + = + + Parent Reference + + Define a reference to the parent object. The syntax for th= is element is [portal-instance].[portal-page]. + For example, default.default means that= the window appears on the default page, in the default portal. + + default.default + = + = + + Region + Specify the region where the window should appear on the p= age + center + + = + + Height + Define the height of the window + 1 + = + = + + Initial Window State + Set the window state indicator by selecting one of three s= tates defined by the JSR-168 specification: + + normal - a portlet shares= this page with other portlets + minimized - a portlet may= show very little information or none at all + maximized - a portlet may= be the only portlet displayed on this page + + + maximized + = + + +

+ + +

+ = +

+ JSF/Seam Portlet Wizard + = + The JSF/Seam Portlet wizard, that is merged = into one JSF and Seam Portlet wizards, helps you create a = + JSF/Seam portlet that uses the JBoss Portlet Bridge libraries. The default values in this wizard = + depend on the configuration set for the project. For instance, if you = set the JSF configuration, the default values in this wizard will be = + as for a JSF portlet. + + The JSF/Seam Portlet wizard could be started= from the File or = + context menu of your project by following to = + New > Other > JBoss Tools Web > Portlet &= gt; JSF/Seam Portlet. + = + The wizard includes three pages to adjust JSF/Seam portlet settin= g: + = + + + The first wizard page asks to select a project to add JSF/Seam = portlet and set a class file destination. + = +

+ First Page of the JSF Portlet Wizard + + + + + + + = + + JSF/Seam Portlet Wizard. First Page Options. = + + + + + = + + + Option = + Description + Default + + + + + Project + Select the project to add a new JSF/Seam portlet + The project selected when the wizard has been started + = + = + + Class name + Type or click Browse to select a class for a JSF/Seam portlet + javax.portlet.faces.GenericFacesPortlet + = + + +

+ + = + + The second page allows to configure a portlet deployment descri= ptors. + = +

+ Second Page of the JSF Portlet Wizard + + + + + + + = + + JSF/Seam Portlet Wizard. Second Page Options. = + + + + + = + + + Option = + Description + Default (JSF / Seam) + + + + + Name + Enter the portlet name. It does not have to be the portlet= class name. + riPortlet / seamPortlet + = + = + + Display name + Enter the display name of the Java portlet + JBoss JSF Portlet / JBoss Seam Portlet + = + = + + Title + Enter the title of the portlet + JBoss JSF Portlet / JBoss Seam Portlet + = + = + + Description + Enter the description of the portlet's function + <blank> + = + = + + Portlet Modes + Select one or more of three modes defined by the JSR-286 s= pecification: = + + View - generates markup r= eflecting the current state of the portlet + Edit - allows customizing= the behavior of the portlet + Help - provides an inform= ation on how to use the portlet + + + View, Edit, Help / View + = + = + + Initialization Parameters + Specify initialization parameters to create an initial sta= te inside your portlet class. Click = + Add and fill in the = + Name, Value and + Description (optional)= fields to set a parameter. + javax.portlet.faces.defaultViewId.view, javax.portlet.face= s.defaultViewId.edit, + javax.portlet.faces.defaultViewId.help / javax.portlet.faces.def= aultViewId.view + = + + +

+ + = + + The last wizard page helps you configure the JBoss Portlet spec= ific information. + = +

+ Third Page of the JSF Portlet Wizard + + + + + + + = + + JSF/Seam Portlet Wizard. Third Page Options. = + + + + + = + + + Option = + Description + Default (JSF / Seam) + + + + + Create Portlet Instance + Clear the Create Portlet Instance check box, + if you don't wont the wizard to create the deployment eleme= nts + in the default-object.xml and + portlet-instances.xml files + Selected + = + = + + If Exists + Select one of two options: + + overwrite - destroys the e= xisting object and creates a new one based on the content of the deployment= + keep - maintains the exist= ing object deployment or creates a new one if it does not exist + + + overwrite + = + = + + Instance Name + Enter a name of the portlet instance that the portlet wind= ow represents + JSFPortletInstance / SeamPortletInstance + = + = + + Page Name + If set, the portlet page is created with the name defined<= /entry> + JSFPortlet / SeamPortlet + = + = + + Window Name + Enter a name of the portlet window + JSFPortletWindow / SeamPortletWindow + = + = + + Parent Reference + + Define a reference to the parent object. + For example, default means that the pag= e appears in the default portal. + + default + = + = + + Region + Specify the region where the window should appear on the p= age + center + + = + + Height + Define the height of the window + 1 + = + = + + Initial Window State + Set the window state indicator by selecting one of three s= tates defined by the JSR-168 specification: + + normal - a portlet shares= this page with other portlets + minimized - a portlet may= show very little information or none at all + maximized - a portlet may= be the only portlet displayed on this page + + + maximized + = + = + + Create JBoss Application + + Select to add the jboss-app.xml descrip= tor. + riPortletApp / seamPortletApp - the d= efault name of the JBoss application. You can change it by + typing a new one in the JBoss Application Na= me field. + + Selected + + = + + Add the jboss-portlet.xml file + Select to create the jboss-portlet.xml = file + Selected + = + = + + Copy JSF Templates + Select to add the folder with JSF templates (edit= .jsp, help.jsp, = + view.jsp) to the project + Cleared + = + + +

+ + +

+ = +

+ JBoss Portlet Preferences + = + To open JBoss Portlet Preferences property sh= eet, go to + Window > Preferences + and then + JBoss Tools > JBoss Portlet. + + = +

+ JBoss Runtime Preferences + + + + + + + = + The + Check runtimes for Portlet Components + option makes the JBoss Portlet functionality always visible = no matter what the runtime is set. By default the option is checked. +

+ + + + <diffmk:wrapper diffmk:change=3D"changed">Summary</diffmk:wrapper>= + = + In conclusion, with this = document you could easily get started with JBoss + Portlet Tools. + The above chapters walked you through the steps on how to organize a web= project with + JBoss Portlet capabilities enabled, create a Java portlet, JSF or Seam po= rtlet and deploy them to JBoss + Portal. The document also includes the reference of JBoss Portlet = Tools= features. + = + If you have questions or suggestions concerned both the documentati= on and tools behavior, you are welcome + to JBoss Tools Users forum. + Ple= ase, use Jira<= /diffmk:wrapper> to report = bugs and requests on documentation. + = +

+ <diffmk:wrapper diffmk:change=3D"added">O= ther Relevant Resources on the Topic</diffmk:wrapper> + = + + + + JBoss Portal home page: http://www.jboss.org/jbossportal/ + + + = + + + JBoss Portal Wiki at: http://wiki.jboss.org/wiki/JBossPortal + + + = + + = JBoss Portal documentation set at: http://docs.jboss.org/jbportal/ + + = + + + JBoss Tools home page at: http://www.jboss.org/tools/ + + + = + + + The latest JBossTools/JBDS documentation builds at: = http://download.jbos= s.org/jbosstools/nightly-docs/ + + + = + + = JBoss Developer Studio/JBoss Tools release documentation you can = + find at http://docs= .jboss.org/tools in the corresponding release directory. + + + = +

+ + --===============3367378386806152498==--