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.effect;
20
21 import org.apache.myfaces.custom.div.Div;
22
23 /**
24 * provides javascript effects which are from the script.aculo.us library
25 * and from the fat fade anything technique library
26 *
27 * @JSFComponent
28 * name = "s:effect"
29 * class = "org.apache.myfaces.custom.effect.Effect"
30 * tagClass = "org.apache.myfaces.custom.effect.EffectTag"
31 *
32 * @author Leonardo
33 *
34 */
35 public abstract class AbstractEffect extends Div
36 {
37 public static final String COMPONENT_TYPE = "org.apache.myfaces.Effect";
38 static public final String DEFAULT_RENDERER_TYPE =
39 "org.apache.myfaces.effect.EffectRenderer";
40
41 /**
42 * @JSFProperty
43 * defaultValue="\"\""
44 * @return
45 */
46 public abstract String getFadeColor();
47
48 /**
49 * @JSFProperty
50 * defaultValue="Integer.valueOf(500)"
51 * @return
52 */
53 public abstract Integer getDuration();
54
55 /**
56 * @JSFProperty
57 * defaultValue="false"
58 * @return
59 */
60 public abstract Boolean getFade();
61
62 /**
63 * @JSFProperty
64 * defaultValue="false"
65 * @return
66 */
67 public abstract Boolean getPuff();
68
69 /**
70 * @JSFProperty
71 * defaultValue="false"
72 * @return
73 */
74 public abstract Boolean getScale();
75
76 /**
77 * @JSFProperty
78 * defaultValue="Integer.valueOf(150)"
79 * @return
80 */
81 public abstract Integer getScaleSize();
82
83 /**
84 * @JSFProperty
85 * defaultValue="false"
86 * @return
87 */
88 public abstract Boolean getSquish();
89
90 /**
91 * @JSFProperty
92 * defaultValue="false"
93 * @return
94 */
95 public abstract Boolean getPulsate();
96
97 }