org.apache.myfaces.custom.effect
Class AbstractEffectScaleClientBehavior

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.AbstractEffectScaleClientBehavior
All Implemented Interfaces:
javax.faces.component.behavior.Behavior, javax.faces.component.behavior.ClientBehavior, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder

public abstract class AbstractEffectScaleClientBehavior
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
AbstractEffectScaleClientBehavior()
           
 
Method Summary
abstract  java.lang.String getPercent()
          Percent value used to indicate the final scale.
abstract  java.lang.Boolean getScaleContent()
          Sets whether content scaling should be enabled, defaults to true.
abstract  java.lang.Integer getScaleFrom()
          integer value, percentage (0%-100%), defaults to 100
abstract  java.lang.Boolean getScaleFromCenter()
          If true, scale the element in a way that the center of the element stays on the same position on the screen, defaults to false.
abstract  java.lang.String getScaleMode()
          Either 'box' (default, scales the visible area of the element) or 'contents' (scales the complete element, that is parts normally only visible by scrolling are taken into account).
abstract  java.lang.Boolean getScaleX()
          Sets whether the element should be scaled horizontally, defaults to true.
abstract  java.lang.Boolean getScaleY()
          Sets whether the element should be scaled vertically, defaults to true.
 
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

AbstractEffectScaleClientBehavior

public AbstractEffectScaleClientBehavior()
Method Detail

getPercent

@JSFProperty
public abstract java.lang.String getPercent()
Percent value used to indicate the final scale.

Returns:

getScaleX

@JSFProperty
public abstract java.lang.Boolean getScaleX()
Sets whether the element should be scaled horizontally, defaults to true.

Returns:

getScaleY

@JSFProperty
public abstract java.lang.Boolean getScaleY()
Sets whether the element should be scaled vertically, defaults to true.

Returns:

getScaleContent

@JSFProperty
public abstract java.lang.Boolean getScaleContent()
Sets whether content scaling should be enabled, defaults to true.

Returns:

getScaleFromCenter

@JSFProperty
public abstract java.lang.Boolean getScaleFromCenter()
If true, scale the element in a way that the center of the element stays on the same position on the screen, defaults to false.

Returns:

getScaleMode

@JSFProperty
public abstract java.lang.String getScaleMode()
Either 'box' (default, scales the visible area of the element) or 'contents' (scales the complete element, that is parts normally only visible by scrolling are taken into account). You can also precisely control the size the element will become by assigning the originalHeight and originalWidth variables to scaleMode. Example: scaleMode: { originalHeight: 900, originalWidth: 900 }

Returns:

getScaleFrom

@JSFProperty
public abstract java.lang.Integer getScaleFrom()
integer value, percentage (0%-100%), defaults to 100

Returns:


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