Skip to content
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

Jump to bottom

Fix #11434: Update docs to Jakarta #11909

Merged
merged 2 commits into from
May 10, 2024
Merged

Fix #11434: Update docs to Jakarta #11909

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c3a216c
Fix #11434: Update docs to Jakarta
melloware May 10, 2024
317fb2a
Update signature.md
melloware May 10, 2024
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
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,11 +124,11 @@ For a full list of the available downloads, please visit the [download page](htt
```xml
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"
xmlns:h="http://xmlns.jcp.org/jsf/html"
xmlns:f="http://xmlns.jcp.org/jsf/core"
xmlns:pt="http://xmlns.jcp.org/jsf/passthrough"
xmlns:jsf="http://xmlns.jcp.org/jsf"
xmlns:ui="http://xmlns.jcp.org/jsf/facelets"
xmlns:h="jakarta.faces.html"
xmlns:f="jakarta.faces.core"
xmlns:pt="jakarta.faces.passthrough"
xmlns:jsf="jakarta.faces"
xmlns:ui="jakarta.faces.facelets"
xmlns:p="http://primefaces.org/ui">

<h:head>
Expand Down
4 changes: 2 additions & 2 deletions docs/14_0_0/gettingstarted/download.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Group id is _org.primefaces_ and artifact id is _primefaces._
<dependency>
<groupId>org.primefaces</groupId>
<artifactId>primefaces</artifactId>
<version>14.0.0-SNAPSHOT</version>
<version>14.0.0</version>
</dependency>
```

Expand All @@ -28,7 +28,7 @@ Group id is _org.primefaces_ and artifact id is _primefaces._
<dependency>
<groupId>org.primefaces</groupId>
<artifactId>primefaces</artifactId>
<version>14.0.0-SNAPSHOT</version>
<version>14.0.0</version>
<classifier>jakarta</classifier>
</dependency>
```
14 changes: 7 additions & 7 deletions docs/15_0_0/components/autocomplete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,13 +281,13 @@ Sample REST-service based one JAX-RS and CDI:
```java
import org.primefaces.model.rest.AutoCompleteSuggestion;

import javax.inject.Inject;
import javax.inject.Named;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.MediaType;
import jakarta.inject.Inject;
import jakarta.inject.Named;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.QueryParam;
import jakarta.ws.rs.core.MediaType;
import java.util.List;
import java.util.stream.Collectors;

Expand Down
6 changes: 3 additions & 3 deletions docs/15_0_0/components/colorpicker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,9 +204,9 @@ are below. For full localization see the [localization documentation](/core/loc

| Event | Listener Parameter | Fired |
| --- | --- | --- |
| change | javax.faces.event.AjaxBehaviorEvent | On change.
| open | javax.faces.event.AjaxBehaviorEvent | On open of the popup in popup mode.
| close | javax.faces.event.AjaxBehaviorEvent | On close of the popup in popup mode.
| change | jakarta.faces.event.AjaxBehaviorEvent | On change.
| open | jakarta.faces.event.AjaxBehaviorEvent | On open of the popup in popup mode.
| close | jakarta.faces.event.AjaxBehaviorEvent | On close of the popup in popup mode.


## Client Side API
Expand Down
4 changes: 2 additions & 2 deletions docs/15_0_0/components/datatable.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -421,7 +421,7 @@ component.
<p:column field="year" headerText="Year" footerText="lte" filterMatchMode="lte">
<f:facet name="filter">
<p:spinner onchange="PF('carsTable').filter()" min="1960" max="2010">
<f:converter converterId="javax.faces.Integer" />
<f:converter converterId="jakarta.faces.Integer" />
</p:spinner>
</f:facet>
<h:outputText value="#{car.year}" />
Expand All @@ -448,7 +448,7 @@ component.
<p:column field="sold" headerText="Status" footerText="equals" filterMatchMode="equals">
<f:facet name="filter">
<p:selectOneButton onchange="PF('carsTable').filter()">
<f:converter converterId="javax.faces.Boolean" />
<f:converter converterId="jakarta.faces.Boolean" />
<f:selectItem itemLabel="All" itemValue="" />
<f:selectItem itemLabel="Sold" itemValue="true" />
<f:selectItem itemLabel="Sale" itemValue="false" />
Expand Down
12 changes: 6 additions & 6 deletions docs/15_0_0/components/dialog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,14 +123,14 @@ the dialog shows a popup calendar. To customize default focus behavior, use focu

| Event | Listener Parameter | Fired |
| --- | --- | --- |
| open | javax.faces.event.AjaxBehaviorEvent | On open.
| open | jakarta.faces.event.AjaxBehaviorEvent | On open.
| close | org.primefaces.event.CloseEvent | On close.
| minimize | javax.faces.event.AjaxBehaviorEvent | On minimize.
| restoreMinimize | javax.faces.event.AjaxBehaviorEvent | On restore minimize.
| maximize | javax.faces.event.AjaxBehaviorEvent | On maximize.
| restoreMaximize | javax.faces.event.AjaxBehaviorEvent | On restore maximize.
| minimize | jakarta.faces.event.AjaxBehaviorEvent | On minimize.
| restoreMinimize | jakarta.faces.event.AjaxBehaviorEvent | On restore minimize.
| maximize | jakarta.faces.event.AjaxBehaviorEvent | On maximize.
| restoreMaximize | jakarta.faces.event.AjaxBehaviorEvent | On restore maximize.
| move | org.primefaces.event.MoveEvent | On move.
| loadContent | javax.faces.event.AjaxBehaviorEvent | On lazy loading the content when dynamic=true
| loadContent | jakarta.faces.event.AjaxBehaviorEvent | On lazy loading the content when dynamic=true
| resizeStart | org.primefaces.event.ResizeEvent | On resize start.
| resizeStop | org.primefaces.event.ResizeEvent | On resize stop.

Expand Down
2 changes: 1 addition & 1 deletion docs/15_0_0/components/gmap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,7 +401,7 @@ address | null | String | String representation of the address.
latLng | null | LatLng | Coordinates of the address.

## GMap Event API
All classes in event API extends from _javax.faces.event.FacesEvent_.
All classes in event API extends from _jakarta.faces.event.FacesEvent_.

_org.primefaces.event.map.MarkerDragEvent_

Expand Down
2 changes: 1 addition & 1 deletion docs/15_0_0/components/importenum.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Class whose enums would be imported is defined with type property and the var pr
the variable name to use via EL.

```xhtml
<p:importEnum type="javax.faces.application.ProjectStage" var="JsfProjectStages" allSuffix="ALL_ENUM_VALUES" />
<p:importEnum type="jakarta.faces.application.ProjectStage" var="JsfProjectStages" allSuffix="ALL_ENUM_VALUES" />
Development: \#{JsfProjectStages.Development}
```
```xhtml
Expand Down
2 changes: 1 addition & 1 deletion docs/15_0_0/components/orderlist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ public class OrderListBean {
| --- | --- | --- |
select | org.primefaces.event.SelectEvent | When an item selected.
unselect | org.primefaces.event.UnselectEvent | When an item unselected.
reorder | javax.faces.event.AjaxBehaviorEvent | When list is reordered.
reorder | jakarta.faces.event.AjaxBehaviorEvent | When list is reordered.

## Header
A facet called “caption” is provided to display a header content for the orderlist.
Expand Down
2 changes: 1 addition & 1 deletion docs/15_0_0/components/outputlabel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ standard outputLabel component cannot apply focus to these, however PrimeFaces o
When _indicateRequired_ is `auto` and the target input is required, or _indicateRequired_ is `true`, outputLabel displays * symbol next to the value.

In case of _indicateRequired_ is set to `auto` and the input is not marked as required, PrimeFaces will automatically check for @NotBlank/@NotEmpty.
PrimeFaces also checks for @NotNull, but only when `javax.faces.INTERPRET_EMPTY_STRING_SUBMITTED_VALUES_AS_NULL` is set to `true`.
PrimeFaces also checks for @NotNull, but only when `jakarta.faces.INTERPRET_EMPTY_STRING_SUBMITTED_VALUES_AS_NULL` is set to `true`.

In case of _indicateRequired_ is set to `autoSkipDisabled` it is the same as `auto` except is will check the state of the
input component if it is read-only or disabled.
Expand Down
6 changes: 3 additions & 3 deletions docs/15_0_0/components/overlaypanel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@ _showEvent_ and _hideEvent_ options.

| Event | Listener Parameter | Fired |
| --- | --- | --- |
| show | javax.faces.event.AjaxBehaviorEvent | On show.
| hide | javax.faces.event.AjaxBehaviorEvent | On hide.
| loadContent | javax.faces.event.AjaxBehaviorEvent | On dynamic content load.
| show | jakarta.faces.event.AjaxBehaviorEvent | On show.
| hide | jakarta.faces.event.AjaxBehaviorEvent | On hide.
| loadContent | jakarta.faces.event.AjaxBehaviorEvent | On dynamic content load.

## Positioning
By default, left top corner of panel is aligned to left bottom corner of the target if there is enough
Expand Down
4 changes: 2 additions & 2 deletions docs/15_0_0/components/picklist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ players(name, age ...).
<p:pickList value="#{pickListBean.players}" var="player"
itemLabel="#{player.name}" itemValue="#{player}" converter="player">
```
PlayerConverter in this case should implement _javax.faces.convert.Converter_ contract and
PlayerConverter in this case should implement _jakarta.faces.convert.Converter_ contract and
implement getAsString, getAsObject methods. Note that a converter is always necessary for
primitive types like long, integer, boolean as well.

Expand Down Expand Up @@ -196,7 +196,7 @@ The following AJAX behavior events are available for this component. If no event
| --- | --- | --- |
select | org.primefaces.event.SelectEvent | When an item selected.
unselect | org.primefaces.event.UnselectEvent | When an item unselected.
reorder | javax.faces.event.AjaxBehaviorEvent | When list is reordered.
reorder | jakarta.faces.event.AjaxBehaviorEvent | When list is reordered.
transfer | org.primefaces.event.TransferEvent | When an item is moved to another list.


Expand Down
2 changes: 1 addition & 1 deletion docs/15_0_0/components/progressbar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ the interval attribute.

| Event | Listener Parameter | Fired |
| --- | --- | --- |
| complete | javax.faces.event.AjaxBehaviorEvent | Is fired when the progress is completed
| complete | jakarta.faces.event.AjaxBehaviorEvent | Is fired when the progress is completed


Example below demonstrates how to use this event:
Expand Down
4 changes: 2 additions & 2 deletions docs/15_0_0/components/sidebar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,9 @@ content specify baseZIndex property. In example below, initial zIndex of the sid

| Event | Listener Parameter | Fired |
| --- | --- | --- |
| open | javax.faces.event.AjaxBehaviorEvent | On open.
| open | jakarta.faces.event.AjaxBehaviorEvent | On open.
| close | org.primefaces.event.CloseEvent | On close.
| loadContent | javax.faces.event.AjaxBehaviorEvent | On dynamic content load.
| loadContent | jakarta.faces.event.AjaxBehaviorEvent | On dynamic content load.

## Client Side API
Widget: _PrimeFaces.widget.Sidebar_
Expand Down
2 changes: 1 addition & 1 deletion docs/15_0_0/components/signature.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,4 +171,4 @@ Widget: _PrimeFaces.widget.Signature_
| Method | Params | Return Type | Description |
| --- | --- | --- | --- |
| disable() | - | void | Disables the input field |
| enable() | - | void | Enables the input field |
| enable() | - | void | Enables the input field |
2 changes: 1 addition & 1 deletion docs/15_0_0/components/terminal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ terminal nested inside a dialog;

| Event | Listener Parameter | Fired |
| --- | --- | --- |
| command | javax.faces.event.AjaxBehaviorEvent | On submission of any command in the terminal.
| command | jakarta.faces.event.AjaxBehaviorEvent | On submission of any command in the terminal.


## Skinning
Expand Down
4 changes: 2 additions & 2 deletions docs/15_0_0/components/timeline.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,8 @@ timeline javascript gets loaded. Following is an example of Spanish localization
```xhtml
<!DOCTYPE html>
<html xmlns="http://www.w3c.org/1999/xhtml"
xmlns:h="http://xmlns.jcp.org/jsf/html"
xmlns:f="http://xmlns.jcp.org/jsf/core"
xmlns:h="jakarta.faces.html"
xmlns:f="jakarta.faces.core"
xmlns:p="http://primefaces.org/ui">
<h:head>
<f:facet name="first">
Expand Down
4 changes: 2 additions & 2 deletions docs/15_0_0/components/tooltip.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ attribute instead of title.

```xhtml
<html xmlns="http://www.w3.org/1999/xhtml"
xmlns:h="http://xmlns.jcp.org/jsf/html"
xmlns:pt="http://xmlns.jcp.org/jsf/passthrough"
xmlns:h="jakarta.faces.html"
xmlns:pt="jakarta.faces.passthrough"
xmlns:p="http://primefaces.org/ui">
<h:head></h:head>
<h:body>
Expand Down
4 changes: 2 additions & 2 deletions docs/15_0_0/components/tree.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,9 +312,9 @@ expand | org.primefaces.event.NodeExpandEvent | When a node is expanded.
collapse | org.primefaces.event.NodeCollapseEvent | When a node is collapsed.
select | org.primefaces.event.NodeSelectEvent | When a node is selected.
unselect | org.primefaces.event.NodeUnselectEvent | When a node is unselected.
dragdrop | javax.faces.event.TreeDragDropEvent | When a node is dropped.
dragdrop | jakarta.faces.event.TreeDragDropEvent | When a node is dropped.
contextMenu | org.primefaces.event.NodeSelectEvent | When a context menu is shown.
filter | javax.faces.event.AjaxBehaviorEvent | When the tree gets filtered.
filter | jakarta.faces.event.AjaxBehaviorEvent | When the tree gets filtered.

Following tree has three listeners;

Expand Down
4 changes: 2 additions & 2 deletions docs/15_0_0/components/wizard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ Wizard provides custom ajax behavior events to configure the built-in AJAX reque

| Event | Listener Parameter | Fired |
| --- | --- | --- |
next | javax.faces.event.AjaxBehaviorEvent | When "next" is triggered
back | javax.faces.event.AjaxBehaviorEvent | When "back" is triggered
next | jakarta.faces.event.AjaxBehaviorEvent | When "next" is triggered
back | jakarta.faces.event.AjaxBehaviorEvent | When "back" is triggered

## Getting Started with Wizard
Each step in the flow is represented with a tab. As an example following wizard is used to create a
Expand Down
2 changes: 1 addition & 1 deletion docs/15_0_0/core/beanvalidationtransformation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ To enable full support for `@NotNull`, `InterpretEmptyStringAsNull` has to be se

```xml
<context-param>
<param-name>javax.faces.INTERPRET_EMPTY_STRING_SUBMITTED_VALUES_AS_NULL</param-name>
<param-name>jakarta.faces.INTERPRET_EMPTY_STRING_SUBMITTED_VALUES_AS_NULL</param-name>
<param-value>true</param-value>
</context-param>
```
Expand Down
11 changes: 2 additions & 9 deletions docs/15_0_0/core/clientwindow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Faces 4.0 also contains a new `@ClientWindowScoped`, which enables you to store
It can be activated via web.xml:
```xml
<context-param>
<param-name>javax.faces.CLIENT_WINDOW_MODE</param-name>
<param-name>jakarta.faces.CLIENT_WINDOW_MODE</param-name>
<param-value>url</param-value>
</context-param>
```
Expand All @@ -32,7 +32,7 @@ PrimeFaces `ClientWindow` can be activated in `faces-config.xml`:
</faces-config>
```

As it´s a replacement for the standard JSF-mechanism, make sure you dont have a `javax.faces.CLIENT_WINDOW_MODE` in your web.xml or configured to `none`.
As it´s a replacement for the standard JSF-mechanism, make sure you dont have a `jakarta.faces.CLIENT_WINDOW_MODE` in your web.xml or configured to `none`.


**Mojarra:**
Expand All @@ -45,10 +45,3 @@ For older Mojarra versions you must use the LifeCycleFactory because of this iss
</faces-config>
```








2 changes: 1 addition & 1 deletion docs/15_0_0/core/contentsecuritypolicy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ response.addHeader("Content-Security-Policy", "script-src 'self' 'nonce-YTQyM2Zi
**Script Output**
```xml
<script type="text/javascript"
src="/showcase/javax.faces.resource/jquery/jquery.js.xhtml?ln=primefaces&amp;v=8.0"
src="/showcase/jakarta.faces.resource/jquery/jquery.js.xhtml?ln=primefaces&amp;v=8.0"
nonce="YTQyM2ZiNTktNjFhZS00ZjI1LWEzMWItZGYzOTE0ZWQ1NDU1" />
```
## Default Policy
Expand Down
18 changes: 9 additions & 9 deletions docs/15_0_0/core/csv.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,12 +95,12 @@ Your custom validator must implement ClientValidator interface to provide the id
package org.primefaces.examples.validate;
import java.util.Map;
import java.util.regex.Pattern;
import javax.faces.application.FacesMessage;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.validator.FacesValidator;
import javax.faces.validator.Validator;
import javax.faces.validator.ValidatorException;
import jakarta.faces.application.FacesMessage;
import jakarta.faces.component.UIComponent;
import jakarta.faces.context.FacesContext;
import jakarta.faces.validator.FacesValidator;
import jakarta.faces.validator.Validator;
import jakarta.faces.validator.ValidatorException;
import org.primefaces.validate.ClientValidator;

@FacesValidator("custom.emailValidator")
Expand Down Expand Up @@ -191,7 +191,7 @@ Your _Converter_ can simply implement _ClientConverter_ and provide a implementa
Here is the example of the built on _BooleanConverter_:

```java
public class BooleanConverter extends javax.faces.convert.BooleanConverter implements ClientConverter {
public class BooleanConverter extends jakarta.faces.convert.BooleanConverter implements ClientConverter {

@Override
public String getConverterId() {
Expand All @@ -201,11 +201,11 @@ public class BooleanConverter extends javax.faces.convert.BooleanConverter imple
```

```js
PrimeFaces.converter['javax.faces.Boolean'] = {
PrimeFaces.converter['jakarta.faces.Boolean'] = {

regex: /^[-+]?\d+$/,

MESSAGE_ID: 'javax.faces.converter.BooleanConverter.BOOLEAN',
MESSAGE_ID: 'jakarta.faces.converter.BooleanConverter.BOOLEAN',

convert: function(element, submittedValue) {
if(submittedValue === null) {
Expand Down
8 changes: 4 additions & 4 deletions docs/15_0_0/core/csvMessages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,23 +20,23 @@ Mojarra do not the label of the field but MyFaces does. For example;

Mojarra:
```js
javax.faces.validator.BeanValidator.MESSAGE={0}
jakarta.faces.validator.BeanValidator.MESSAGE={0}
```

MyFaces:
```js
javax.faces.validator.BeanValidator.MESSAGE={1}: {0}
jakarta.faces.validator.BeanValidator.MESSAGE={1}: {0}
```

Default CSV messages follow the convention of Mojarra.
However if you prefer to display the label along with the message, you can override it by adding {1} to the message.

Default:
```js
PrimeFaces.locales['en_US'].messages['javax.faces.validator.BeanValidator.MESSAGE'] = '{0}';
PrimeFaces.locales['en_US'].messages['jakarta.faces.validator.BeanValidator.MESSAGE'] = '{0}';
```

With Label:
```js
PrimeFaces.locales['en_US'].messages['javax.faces.validator.BeanValidator.MESSAGE'] = '{1}: {0}';
PrimeFaces.locales['en_US'].messages['jakarta.faces.validator.BeanValidator.MESSAGE'] = '{1}: {0}';
```
4 changes: 2 additions & 2 deletions docs/15_0_0/core/dialogframework.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Simplest use case of DF is opening an xhtml view like _cars.xhtml_ in a dialog;

```xhtml
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:h="http://java.sun.com/jsf/html"
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:h="jakarta.faces.html"
xmlns:p="http://primefaces.org/ui">
<h:head>
<title>Cars</title>
Expand Down Expand Up @@ -173,7 +173,7 @@ The trigger component needs to have _dialogReturn_ ajax behavior event to hook-i

```xhtml
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:h="http://java.sun.com/jsf/html"
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:h="jakarta.faces.html"
xmlns:p="http://primefaces.org/ui">
<h:head>
<title>Cars</title>
Expand Down
Loading