/
OnloadScript.java
164 lines (142 loc) · 6.04 KB
/
OnloadScript.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
/*
* Copyright 2021 OmniFaces
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*/
package org.omnifaces.component.script;
import static org.omnifaces.util.Ajax.oncomplete;
import static org.omnifaces.util.Events.subscribeToViewEvent;
import static org.omnifaces.util.FacesLocal.isAjaxRequestWithPartialRendering;
import java.io.IOException;
import java.io.StringWriter;
import javax.faces.FacesException;
import javax.faces.component.FacesComponent;
import javax.faces.component.UIViewRoot;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import javax.faces.context.ResponseWriterWrapper;
import javax.faces.event.ComponentSystemEvent;
import javax.faces.event.ListenerFor;
import javax.faces.event.PostAddToViewEvent;
import javax.faces.event.PostRestoreStateEvent;
import javax.faces.event.PreRenderViewEvent;
import javax.faces.event.SystemEvent;
import javax.faces.event.SystemEventListener;
import org.omnifaces.util.Ajax;
/**
* <p>
* The <code><o:onloadScript</code> is a component that extends the standard <code><h:outputScript></code>
* which will be executed in the end of the HTML body (thus when all HTML elements are initialized in the HTML DOM tree)
* and will re-execute its script body on every ajax request. This is particularly useful if you want to re-execute a
* specific helper script to manipulate the HTML DOM tree, such as (re-)adding fancy tooltips, performing highlights,
* etcetera, also after changes in the HTML DOM tree on ajax responses.
* <p>
* You can put it anywhere in the view, it will always be relocated to the end of body.
* <pre>
* <o:onloadScript>alert('OnloadScript is invoked!');</o:onloadScript>
* </pre>
* <p>
* The <code><o:onloadScript></code> is implicitly relocated to the end of the <code><body></code>,
* exactly like as <code><h:outputScript target="body"></code> does. So it's always executed when the entire
* <code><body></code> is finished populating and thus you don't need a <code>window.onload</code> or a
* <code>$(document).ready()</code> in there. Again, the difference with <code><h:outputScript target="body"></code>
* is that the <code><o:onloadScript></code> is also executed on every ajax request.
*
* @author Bauke Scholtz
* @see ScriptFamily
*/
@FacesComponent(OnloadScript.COMPONENT_TYPE)
@ListenerFor(systemEventClass=PostAddToViewEvent.class)
@ListenerFor(systemEventClass=PostRestoreStateEvent.class)
public class OnloadScript extends ScriptFamily implements SystemEventListener {
// Public constants -----------------------------------------------------------------------------------------------
/** The standard component type. */
public static final String COMPONENT_TYPE = "org.omnifaces.component.script.OnloadScript";
// Actions --------------------------------------------------------------------------------------------------------
/**
* Move this component to body using {@link #moveToBody(ComponentSystemEvent)}, and if the event is a
* {@link PostRestoreStateEvent}, then subscribe this component to {@link PreRenderViewEvent}, which will invoke
* {@link #processEvent(SystemEvent)}.
*/
@Override
public void processEvent(ComponentSystemEvent event) {
moveToBody(event);
if (event instanceof PostRestoreStateEvent) {
subscribeToViewEvent(PreRenderViewEvent.class, this);
}
}
/**
* Returns <code>true</code> if the given source is an instance of {@link OnloadScript} or {@link UIViewRoot}.
*/
@Override
public boolean isListenerForSource(Object source) {
return source instanceof OnloadScript || source instanceof UIViewRoot;
}
/**
* If the event is a {@link PreRenderViewEvent}, and this component is rendered, and the current request is an ajax
* request with partial rendering, then encode the children as {@link Ajax#oncomplete(String...)}.
*/
@Override
public void processEvent(SystemEvent event) {
if (!(event instanceof PreRenderViewEvent) || !isRendered()) {
return;
}
FacesContext context = getFacesContext();
if (!isAjaxRequestWithPartialRendering(context)) {
return;
}
pushComponentToEL(context, this);
StringWriter buffer = new StringWriter();
ResponseWriter originalResponseWriter = context.getResponseWriter();
String encoding = context.getExternalContext().getRequestCharacterEncoding();
context.getExternalContext().setResponseCharacterEncoding(encoding);
ResponseWriter writer = context.getRenderKit().createResponseWriter(buffer, null, encoding);
context.setResponseWriter(new ResponseWriterWrapper(writer) {
@Override
public void writeText(Object text, String property) throws IOException {
getWrapped().write(text.toString()); // So, don't escape HTML.
}
});
try {
encodeChildren(context);
}
catch (IOException e) {
throw new FacesException(e);
}
finally {
popComponentFromEL(context);
if (originalResponseWriter != null) {
context.setResponseWriter(originalResponseWriter);
}
}
String script = buffer.toString().trim();
if (!script.isEmpty()) {
oncomplete(script);
}
}
/**
* If the current request is not an ajax request with partial rendering, then encode begin.
*/
@Override
public void encodeBegin(FacesContext context) throws IOException {
if (!isAjaxRequestWithPartialRendering(context)) {
super.encodeBegin(context);
}
}
/**
* If the current request is not an ajax request with partial rendering, then encode end.
*/
@Override
public void encodeEnd(FacesContext context) throws IOException {
if (!isAjaxRequestWithPartialRendering(context)) {
super.encodeEnd(context);
}
}
}