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:effectHighlight",
33          clazz="org.apache.myfaces.custom.effect.EffectHighlightBehavior",
34          bodyContent="empty")
35  public abstract class AbstractEffectHighlightClientBehavior extends EffectClientBehaviorBase
36  {
37      public static final String BEHAVIOR_ID = "org.apache.myfaces.custom.effect.EffectHighlightBehavior";
38      public static final String RENDERER_TYPE = "org.apache.myfaces.custom.effect.EffectHighlightBehavior";
39  
40      public AbstractEffectHighlightClientBehavior()
41      {
42      }
43      
44      /**
45       * Sets the color of first frame of the highlight. Defaults to "#ffff99" (a light yellow).
46       * 
47       * @return
48       */
49      @JSFProperty
50      public abstract String getStartcolor();
51      
52      /**
53       * Sets the color of the last frame of the highlight. This is best set to 
54       * the background color of the highlighted element. Defaults to "#ffffff" 
55       * (white).
56       * 
57       * @return
58       */
59      @JSFProperty
60      public abstract String getEndcolor();
61      
62      /**
63       * Sets the background-color of the element after the highlight has finished. 
64       * Defaults to the current background-color of the highlighted element 
65       * (see Note).
66       * 
67       * @return
68       */
69      @JSFProperty
70      public abstract String getRestorecolor();
71  
72      /**
73       * Unless this is set to true, any background image on the element will 
74       * not be preserved.
75       * 
76       * @return
77       */
78      @JSFProperty
79      public abstract Boolean getKeepBackgroundImage();
80  
81  }