1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.myfaces.custom.submitOnEvent;
20
21 import javax.faces.component.UIComponentBase;
22
23 /**
24 * Attach an event handler to an input element or use a global event handler to
25 * submit a form by "clicking" on a link or button
26 *
27 * @JSFComponent
28 * name = "s:submitOnEvent"
29 * class = "org.apache.myfaces.custom.submitOnEvent.SubmitOnEvent"
30 * tagClass = "org.apache.myfaces.custom.submitOnEvent.SubmitOnEventTag"
31 *
32 * @author Mario Ivankovits (imario -at - apache.org)
33 */
34 public abstract class AbstractSubmitOnEvent extends UIComponentBase
35 {
36 public static final String COMPONENT_TYPE = "org.apache.myfaces.SubmitOnEvent";
37 public static final String DEFAULT_RENDERER_TYPE = "org.apache.myfaces.SubmitOnEvent";
38 public static final String COMPONENT_FAMILY = "org.apache.myfaces.SubmitOnEvent";
39
40 /**
41 * The component (commandLink or commandButton) to "click" on
42 *
43 * @JSFProperty
44 */
45 public abstract String getFor();
46
47 /**
48 * The event: keypress|keydown|keyup|change|focus|blur|click|mousedown|mouseup|mousemove|mouseover|mouseout|select (Default: keypress)
49 *
50 * @JSFProperty
51 */
52 public abstract String getEvent();
53
54 /**
55 * User defined javascript callback function. This function will be called to
56 * decide if the event should trigger the submit. (Default: fire on "Enter")
57 *
58 * @JSFProperty
59 */
60 public abstract String getCallback();
61
62 }