org.apache.myfaces.custom.effect
Class AbstractEffectHighlightClientBehavior

java.lang.Object
  extended by javax.faces.component.behavior.BehaviorBase
      extended by javax.faces.component.behavior.ClientBehaviorBase
          extended by org.apache.myfaces.custom.behavior.ClientBehaviorBase
              extended by org.apache.myfaces.custom.effect.EffectClientBehaviorBase
                  extended by org.apache.myfaces.custom.effect.AbstractEffectHighlightClientBehavior
All Implemented Interfaces:
javax.faces.component.behavior.Behavior, javax.faces.component.behavior.ClientBehavior, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder

public abstract class AbstractEffectHighlightClientBehavior
extends EffectClientBehaviorBase

Convenient wrapper for scriptaculous Effect.Appear

Author:
Leonardo Uribe

Field Summary
static java.lang.String BEHAVIOR_ID
           
static java.lang.String RENDERER_TYPE
           
 
Constructor Summary
AbstractEffectHighlightClientBehavior()
           
 
Method Summary
abstract  java.lang.String getEndcolor()
          Sets the color of the last frame of the highlight.
abstract  java.lang.Boolean getKeepBackgroundImage()
          Unless this is set to true, any background image on the element will not be preserved.
abstract  java.lang.String getRestorecolor()
          Sets the background-color of the element after the highlight has finished.
abstract  java.lang.String getStartcolor()
          Sets the color of first frame of the highlight.
 
Methods inherited from class org.apache.myfaces.custom.effect.EffectClientBehaviorBase
getAppendJs, getForId, setAppendJs, setForId
 
Methods inherited from class org.apache.myfaces.custom.behavior.ClientBehaviorBase
getFacesContext, getStateHelper, getStateHelper, getValueExpression, restoreAttachedState, restoreState, saveAttachedState, saveState, setValueExpression
 
Methods inherited from class javax.faces.component.behavior.ClientBehaviorBase
decode, getHints, getRenderer, getRendererType, getScript
 
Methods inherited from class javax.faces.component.behavior.BehaviorBase
addBehaviorListener, broadcast, clearInitialState, initialStateMarked, isTransient, markInitialState, removeBehaviorListener, setTransient
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.faces.component.behavior.Behavior
broadcast
 

Field Detail

BEHAVIOR_ID

public static final java.lang.String BEHAVIOR_ID
See Also:
Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE
See Also:
Constant Field Values
Constructor Detail

AbstractEffectHighlightClientBehavior

public AbstractEffectHighlightClientBehavior()
Method Detail

getStartcolor

@JSFProperty
public abstract java.lang.String getStartcolor()
Sets the color of first frame of the highlight. Defaults to "#ffff99" (a light yellow).

Returns:

getEndcolor

@JSFProperty
public abstract java.lang.String getEndcolor()
Sets the color of the last frame of the highlight. This is best set to the background color of the highlighted element. Defaults to "#ffffff" (white).

Returns:

getRestorecolor

@JSFProperty
public abstract java.lang.String getRestorecolor()
Sets the background-color of the element after the highlight has finished. Defaults to the current background-color of the highlighted element (see Note).

Returns:

getKeepBackgroundImage

@JSFProperty
public abstract java.lang.Boolean getKeepBackgroundImage()
Unless this is set to true, any background image on the element will not be preserved.

Returns:


Copyright © 2011 The Apache Software Foundation. All Rights Reserved.