View Javadoc

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.buildtools.maven2.plugin.builder.annotation.JSFClientBehavior;
22  import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFProperty;
23  import org.apache.myfaces.custom.behavior.ClientBehaviorBase;
24  
25  /**
26   * Convenient wrapper for scriptaculous Effect.Appear 
27   * 
28   * @author Leonardo Uribe
29   *
30   */
31  @JSFClientBehavior(
32          name="s:effectSlideDown",
33          clazz="org.apache.myfaces.custom.effect.EffectSlideDownBehavior",
34          bodyContent="empty")
35  public abstract class AbstractEffectSlideDownClientBehavior extends EffectClientBehaviorBase
36  {
37      public static final String BEHAVIOR_ID = "org.apache.myfaces.custom.effect.EffectSlideDownBehavior";
38      public static final String RENDERER_TYPE = "org.apache.myfaces.custom.effect.EffectSlideDownBehavior";
39  
40      public AbstractEffectSlideDownClientBehavior()
41      {
42      }
43  
44      /**
45       * boolean, defaults to false
46       * 
47       * @return
48       */
49      @JSFProperty
50      public abstract Boolean getScaleX();
51      
52      /**
53       * boolean, defaults to true
54       * 
55       * @return
56       */
57      @JSFProperty
58      public abstract Boolean getScaleY();
59      
60      /**
61       * boolean, defaults to true
62       * 
63       * @return
64       */
65      @JSFProperty
66      public abstract Boolean getScaleContent();
67      
68      /**
69       * boolean, defaults to false
70       * 
71       * @return
72       */
73      @JSFProperty
74      public abstract Boolean getScaleFromCenter();
75      
76      /**
77       * string, defaults to 'box', can also be 'contents'
78       * 
79       * @return
80       */
81      @JSFProperty
82      public abstract String getScaleMode();
83      
84      /**
85       * integer value, percentage (0%-100%), defaults to 100
86       * 
87       * @return
88       */
89      @JSFProperty
90      public abstract Integer getScaleFrom();
91      
92      /**
93       * integer value, percentage (0%-100%), defaults to 0
94       * 
95       * @return
96       */
97      @JSFProperty
98      public abstract Integer getScaleTo();
99      
100     /**
101      * float value, in seconds, defaults to 1.0
102      * 
103      * @return
104      */
105     @JSFProperty
106     public abstract Float getDuration();
107 }