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.waypoint.Waypoint} component.
31 *
32 * @author Oleg Varaksin / last modified by Melloware
33 * @version $Revision$
34 * @since 0.6
35 */
36 public class WaypointEvent extends AbstractAjaxBehaviorEvent {
37
38 public static final String NAME = "reached";
39 private static final long serialVersionUID = 1L;
40
41 private final Direction direction;
42
43 private final String waypointId; // client Id of the current waypoint
44
45 public enum Direction {
46 DOWN, UP, RIGHT, LEFT
47 }
48
49 public WaypointEvent(final UIComponent component, final Behavior behavior, final Direction direction,
50 final String waypointId) {
51 super(component, behavior);
52 this.direction = direction;
53 this.waypointId = waypointId;
54 }
55
56 public Direction getDirection() {
57 return direction;
58 }
59
60 public String getWaypointId() {
61 return waypointId;
62 }
63
64 }