net.sourceforge.jstags.tags.effects
Class Slide

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by net.sourceforge.jstags.tags.JSTagsTagSupport
          extended by net.sourceforge.jstags.tags.effects.Effect
              extended by net.sourceforge.jstags.tags.effects.Slide
All Implemented Interfaces:
java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class Slide
extends Effect

It performs an effect similar to blind where the contents of the elements scroll up and down as well. This effect depends on the javascript library Mochikit

Since:
1.0
Author:
sschz@users.sourceforge.net
See Also:
Serialized Form

Field Summary
private  java.lang.String direction
           
private  java.lang.Boolean scaleContent
           
private  java.lang.String scaleFrom
           
private  java.lang.String scaleMode
           
private  java.lang.String scaleTo
           
private  java.lang.Boolean scaleX
           
private  java.lang.Boolean scaleY
           
private static long serialVersionUID
           
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
Slide()
           
 
Method Summary
 java.lang.String getDirection()
           
protected  net.sf.json.JSONObject getOptions()
          It selects those effect properties used to configure it and returns them together with their values (that excludes: shootersSelector, targetId, event)
 java.lang.Boolean getScaleContent()
           
 java.lang.String getScaleFrom()
           
 java.lang.String getScaleMode()
           
 java.lang.String getScaleTo()
           
 java.lang.Boolean getScaleX()
           
 java.lang.Boolean getScaleY()
           
protected  java.lang.String getTemplateName()
           
protected  java.util.Map<java.lang.String,java.lang.String> getTemplateNameValuePairs()
           
 void setDirection(java.lang.String direction)
           
 void setScaleContent(java.lang.Boolean scaleContent)
           
 void setScaleFrom(java.lang.String scaleFrom)
           
 void setScaleMode(java.lang.String scaleMode)
           
 void setScaleTo(java.lang.String scaleTo)
           
 void setScaleX(java.lang.Boolean scaleX)
           
 void setScaleY(java.lang.Boolean scaleY)
           
 
Methods inherited from class net.sourceforge.jstags.tags.effects.Effect
getAfterFinish, getAfterUpdate, getBeforeFinish, getBeforeSetup, getBeforeStart, getBeforeUpdate, getDelay, getDuration, getEvent, getFps, getFrom, getQueue, getShootersSelector, getTargetId, getTo, getTransition, setAfterFinish, setAfterUpdate, setBeforeFinish, setBeforeSetup, setBeforeStart, setBeforeUpdate, setDelay, setDuration, setEvent, setFps, setFrom, setQueue, setShootersSelector, setTargetId, setTo, setTransition
 
Methods inherited from class net.sourceforge.jstags.tags.JSTagsTagSupport
doStartTag, getOutput
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

direction

private java.lang.String direction

scaleX

private java.lang.Boolean scaleX

scaleY

private java.lang.Boolean scaleY

scaleContent

private java.lang.Boolean scaleContent

scaleMode

private java.lang.String scaleMode

scaleFrom

private java.lang.String scaleFrom

scaleTo

private java.lang.String scaleTo
Constructor Detail

Slide

public Slide()
Method Detail

getDirection

public java.lang.String getDirection()
Returns:
Whether the element will slide up or down. Valid values are Up and Down

getScaleContent

public java.lang.Boolean getScaleContent()
Returns:
Whether the element's content should be modified during the effect or not. Default value is true

setScaleContent

public void setScaleContent(java.lang.Boolean scaleContent)
Parameters:
scaleContent - Whether the element's content should be modified during the effect or not. Default value is true

getScaleFrom

public java.lang.String getScaleFrom()
Returns:
Percentage of the element size the transition will start at

setScaleFrom

public void setScaleFrom(java.lang.String scaleFrom)
Parameters:
scaleFrom - Percentage of the element size the transition will start at

getScaleMode

public java.lang.String getScaleMode()
Returns:
How the scale is done. Valid values are box (default one, it scales the visible area of the element) and contents (scales the complete element, that is, it takes into account parts normally only visible by scrolling).

setScaleMode

public void setScaleMode(java.lang.String scaleMode)
Parameters:
scaleMode - How the scale is done. Valid values are box (default one, it scales the visible area of the element) and contents (scales the complete element, that is, it takes into account parts normally only visible by scrolling).

getScaleTo

public java.lang.String getScaleTo()
Returns:
Percentage of the element size the transition will end at

setScaleTo

public void setScaleTo(java.lang.String scaleTo)
Parameters:
scaleTo - Percentage of the element size the transition will end at

getScaleX

public java.lang.Boolean getScaleX()
Returns:
Whether the element's width will change during the effect execution. Default value is false

setScaleX

public void setScaleX(java.lang.Boolean scaleX)
Parameters:
scaleX - Whether the element's width will change during the effect execution. Default value is false

getScaleY

public java.lang.Boolean getScaleY()
Returns:
Whether the element's width will change during the effect execution. Default value is true

setScaleY

public void setScaleY(java.lang.Boolean scaleY)
Parameters:
scaleY - Whether the element's width will change during the effect execution. Default value is true

setDirection

public void setDirection(java.lang.String direction)
Parameters:
direction - Whether the element will slide up or down. Valid values are Up and Down

getTemplateName

protected java.lang.String getTemplateName()
                                    throws javax.servlet.jsp.JspException
Specified by:
getTemplateName in class JSTagsTagSupport
Returns:
name of the .js template used to create the JavaScript code used by this tag
Throws:
javax.servlet.jsp.JspException

getTemplateNameValuePairs

protected java.util.Map<java.lang.String,java.lang.String> getTemplateNameValuePairs()
Overrides:
getTemplateNameValuePairs in class Effect
Returns:
Map of [name, value] pairs representing all the name-value pair used to create the JavaScript code. Such pairs will be used to replace data inside the .js template in order to get the code of a certain effect.

getOptions

protected net.sf.json.JSONObject getOptions()
Description copied from class: Effect
It selects those effect properties used to configure it and returns them together with their values (that excludes: shootersSelector, targetId, event)

Overrides:
getOptions in class Effect
Returns:
a JSONObject containing all the available properties for the effect and their values in the form {propertyName1: propertyValue1, propertyName2: propertyValue2, ...} pairs


Copyright © 2007. All Rights Reserved.