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.event;
23  
24  import javax.faces.component.UIComponent;
25  import javax.faces.component.behavior.Behavior;
26  
27  import org.primefaces.event.AbstractAjaxBehaviorEvent;
28  
29  /**
30   * Event which is triggered by the {@link org.primefaces.extensions.component.clipboard.Clipboard} component when the copy/cut action has failed.
31   *
32   * @author Melloware mellowaredev@gmail.com
33   * @since 6.1
34   */
35  public class ClipboardErrorEvent extends AbstractAjaxBehaviorEvent {
36  
37      public static final String NAME = "error";
38      private static final long serialVersionUID = 1L;
39  
40      /**
41       * action: return the action we aim at the target element. This will return either copy or cut
42       */
43      private final String action;
44  
45      /**
46       * trigger: returns the element which triggered the copy or the cut action.
47       */
48      private final String trigger;
49  
50      public ClipboardErrorEvent(final UIComponent component, final Behavior behavior, final String action,
51                  final String trigger) {
52          super(component, behavior);
53          this.action = action;
54          this.trigger = trigger;
55      }
56  
57      /**
58       * Gets the {@link #action}.
59       *
60       * @return Returns the {@link #action}.
61       */
62      public final String getAction() {
63          return action;
64      }
65  
66      /**
67       * Gets the {@link #trigger}.
68       *
69       * @return Returns the {@link #trigger}.
70       */
71      public final String getTrigger() {
72          return trigger;
73      }
74  
75  }