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:effectMove",
33          clazz="org.apache.myfaces.custom.effect.EffectMoveBehavior",
34          bodyContent="empty")
35  public abstract class AbstractEffectMoveClientBehavior extends EffectClientBehaviorBase
36  {
37      public static final String BEHAVIOR_ID = "org.apache.myfaces.custom.effect.EffectMoveBehavior";
38      public static final String RENDERER_TYPE = "org.apache.myfaces.custom.effect.EffectMoveBehavior";
39  
40      public AbstractEffectMoveClientBehavior()
41      {
42      }
43      
44      /**
45       * integer value, either the new absolute target of the effect 
46       * elements left value or the modifier of its current left value, 
47       * depending on the mode option
48       * 
49       * @return
50       */
51      @JSFProperty
52      public abstract Integer getX();
53  
54      /**
55       * integer value, either the new absolute target of the effect 
56       * elements top value or the modifier of its current top value, 
57       * depending on the mode option
58       * 
59       * @return
60       */
61      @JSFProperty
62      public abstract Integer getY();
63  
64      /**
65       * string, defaults to 'relative', can also be 'absolute', 
66       * specifies if the element is moved absolutely or relative to 
67       * its own position.
68       * 
69       * @return
70       */
71      @JSFProperty
72      public abstract String getMode();
73  }