A reference guide to the components of the Component ...

Component Reference

A reference guide to

the components of the

RichFaces 4 framework

by Brian Leathem (Red Hat), Lukas Fryc (Red Hat), and Sean Rogers (Red Hat)

1. Introduction ................................................................................................................. 1

1.1. Libraries ............................................................................................................. 1

2. Common Ajax attributes ..............................................................................................

2.1. Data processing ..................................................................................................

2.1.1. execute ...................................................................................................

2.1.2. bypassUpdates ........................................................................................

2.2. Rendering ..........................................................................................................

2.2.1. render .....................................................................................................

2.2.2. ajaxRendered ..........................................................................................

2.2.3. limitRender ..............................................................................................

2.3. Queuing and traffic control ..................................................................................

2.3.1. requestDelay ............................................................................................

2.3.2. ignoreDupResponses ...............................................................................

2.4. Events and JavaScript interactions ......................................................................

2.4.1. onbeforesubmit ........................................................................................

2.4.2. onbegin ...................................................................................................

2.4.3. onbeforedomupdate .................................................................................

3

3

3

4

4

4

5

5

6

6

6

6

6

6

7

2.4.4. oncomplete .............................................................................................. 7

2.4.5. onerror .................................................................................................... 7

2.4.6. Registering event callbacks with jQuery ..................................................... 7

I. Ajax control components ................................................................................................. 9

3. Actions ............................................................................................................... 11

3.1. ................................................................................................. 11

3.1.1. Basic usage ................................................................................... 11

3.1.2. Reference data .............................................................................. 11

3.2. ............................................................................................. 11

3.2.1. Basic usage ................................................................................... 12

3.2.2. Interoperability ................................................................................ 12

3.2.3. Passing client-side parameters ........................................................ 13

3.2.4. Reference data .............................................................................. 13

3.3. .................................................................................. 14

3.4. ............................................................................... 14

3.4.1. Basic usage ................................................................................... 14

3.4.2. Reference data .............................................................................. 14

3.5. .................................................................................. 15

3.5.1. Basic usage ................................................................................... 15

3.5.2. Reference data .............................................................................. 15

3.6. ........................................................................................ 15

3.6.1. Basic usage ................................................................................... 15

3.6.2. Parameters and JavaScript ............................................................. 16

3.6.3. Reference data .............................................................................. 17

3.7. .................................................................................................. 17

3.7.1. Timing options ............................................................................... 17

3.7.2. Reference data .............................................................................. 17

iii

Component Reference

3.8. ................................................................................................ 17

3.8.1. Setting up Push ............................................................................. 18

iv

3.8.2. Server-side Push methods ..............................................................

3.8.3. Client-side Push methods ...............................................................

3.8.4. Push Topics ...................................................................................

3.8.5. Handling a push message ..............................................................

3.8.6. Handling a push subscription ..........................................................

3.8.7. Using TopicsContext to publish message .........................................

3.8.8. Integrating Push with CDI events ....................................................

3.8.9. Push and JMS integration ...............................................................

3.8.10. Reference data ............................................................................

4. Resources ..........................................................................................................

4.1. ....................................................................................

4.1.1. Basic usage ...................................................................................

4.1.2. Handling content ............................................................................

4.1.3. Reference data ..............................................................................

5. Containers .........................................................................................................

19

20

20

20

21

22

22

22

26

27

27

27

27

29

31

5.1. .....................................................................................

5.1.1. Aiding complex Ajax rendering ........................................................

5.1.2. Panel appearance ..........................................................................

5.1.3. Reference data ..............................................................................

5.2. ..............................................................................................

5.2.1. Reference data ..............................................................................

6. Validation ...........................................................................................................

6.1. client-side validation ..........................................................

6.1.1. Basic usage ...................................................................................

6.1.2. Messages from client-side validators ...............................................

6.1.3. Validation triggers ..........................................................................

6.1.4. Ajax fall-backs ................................................................................

6.1.5. Reference data ..............................................................................

6.2. object validation .......................................................

6.2.1. Basic usage ...................................................................................

6.2.2. Reference data ..............................................................................

7. Processing management ...................................................................................

7.1. ..............................................................................................

7.1.1. Basic usage ...................................................................................

7.1.2. Delaying requests ..........................................................................

7.1.3. Duplicate responses .......................................................................

7.1.4. Queue scopes ................................................................................

7.1.5. client-side events ........................................................

7.1.6. Reference data ..............................................................................

7.1.7. .........................................................................

7.2. ..................................................................................................

7.2.1. Basic usage ...................................................................................

31

31

31

31

31

32

33

34

34

34

35

36

36

36

37

38

39

39

39

39

39

39

40

40

40

42

42

7.2.2. Log monitoring ............................................................................... 42

7.2.3. Reference data .............................................................................. 43

7.2.4. Style classes and skin parameters ..................................................

7.3. ..............................................................................................

7.3.1. Customizing the text .......................................................................

7.3.2. Specifying a region .........................................................................

7.3.3. JavaScript API ...............................................................................

7.3.4. Reference data ..............................................................................

II. User interface components ...........................................................................................

8. Rich inputs ........................................................................................................

8.1. ..................................................................................

8.1.1. Basic usage ...................................................................................

8.1.2. Submission modes .........................................................................

8.1.3. Interactivity options .........................................................................

8.1.4. Customizing the filter in client and lazyClient modes .........................

8.1.5. JavaScript API ...............................................................................

8.1.6. Reference data ..............................................................................

44

45

45

46

47

47

49

51

51

51

52

52

53

53

54

8.1.7. Style classes and skin parameters ..................................................

8.2. .........................................................................................

8.2.1. Basic usage ...................................................................................

8.2.2. Behavior and appearance ...............................................................

8.2.3. Time of day ...................................................................................

8.2.4. Localization and formatting .............................................................

8.2.5. Using a data model ........................................................................

8.2.6. Client-side customization ................................................................

8.2.7. JavaScript API ...............................................................................

8.2.8. Reference data ..............................................................................

8.2.9. Style classes and skin parameters ..................................................

8.3. ..............................................................................................

8.3.1. Basic usage ...................................................................................

8.3.2. Styling ...........................................................................................

8.3.3. Editor skins ....................................................................................

8.3.4. Advanced configuration ..................................................................

8.3.5. Toolbar customization .....................................................................

8.3.6. Internationalization and localization ..................................................

8.3.7. Client-side event handlers ...............................................................

8.3.8. JavaScript API ...............................................................................

8.3.9. Reference data ..............................................................................

8.3.10. Style classes and skin parameters .................................................

8.4. .......................................................................................

8.4.1. Basic usage ...................................................................................

8.4.2. Upload settings ..............................................................................

8.4.3. Sanitizing file upload input ..............................................................

8.4.4. Interactivity options .........................................................................

54

56

56

56

57

58

58

59

60

61

61

67

67

68

68

69

69

70

70

71

72

72

73

73

73

74

74

v

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download