View Javadoc
1   /*
2    * Copyright (c) 2011-2024 PrimeFaces Extensions
3    *
4    *  Permission is hereby granted, free of charge, to any person obtaining a copy
5    *  of this software and associated documentation files (the "Software"), to deal
6    *  in the Software without restriction, including without limitation the rights
7    *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    *  copies of the Software, and to permit persons to whom the Software is
9    *  furnished to do so, subject to the following conditions:
10   *
11   *  The above copyright notice and this permission notice shall be included in
12   *  all copies or substantial portions of the Software.
13   *
14   *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20   *  THE SOFTWARE.
21   */
22  package org.primefaces.extensions.component.clipboard;
23  
24  import java.io.IOException;
25  
26  import javax.faces.component.UIComponent;
27  import javax.faces.context.FacesContext;
28  
29  import org.primefaces.expression.SearchExpressionUtils;
30  import org.primefaces.extensions.util.ExtLangUtils;
31  import org.primefaces.renderkit.CoreRenderer;
32  import org.primefaces.util.WidgetBuilder;
33  
34  /**
35   * Renderer for the {@link Clipboard} component.
36   *
37   * @author Melloware mellowaredev@gmail.com
38   * @since 6.1
39   */
40  public class ClipboardRenderer extends CoreRenderer {
41  
42      @Override
43      public void decode(final FacesContext context, final UIComponent component) {
44          decodeBehaviors(context, component);
45      }
46  
47      @Override
48      public void encodeEnd(final FacesContext context, final UIComponent component) throws IOException {
49          final Clipboard clipboard = (Clipboard) component;
50          encodeScript(context, clipboard);
51      }
52  
53      private void encodeScript(final FacesContext context, final Clipboard clipboard) throws IOException {
54          String trigger = SearchExpressionUtils.resolveClientIdsForClientSide(context, clipboard, clipboard.getTrigger());
55          if (isValueBlank(trigger)) {
56              trigger = clipboard.getParent().getClientId(context);
57          }
58  
59          final String target = SearchExpressionUtils.resolveClientIdsForClientSide(context, clipboard, clipboard.getTarget());
60  
61          final WidgetBuilder wb = getWidgetBuilder(context);
62          wb.init("ExtClipboard", clipboard);
63          wb.attr("action", ExtLangUtils.lowerCase(clipboard.getAction()));
64          wb.attr("trigger", trigger);
65          wb.attr("target", target);
66          wb.attr("text", clipboard.getText());
67  
68          if (clipboard.getOnsuccess() != null) {
69              // Define a callback function if cut/copy succeeds
70              wb.callback("onSuccess", "function(e)", clipboard.getOnsuccess());
71          }
72          if (clipboard.getOnerror() != null) {
73              // Define a callback function if cut/copy fails
74              wb.callback("onError", "function(e)", clipboard.getOnerror());
75          }
76  
77          encodeClientBehaviors(context, clipboard);
78  
79          wb.finish();
80      }
81  
82  }