| java.lang.Object
 com.icesoft.faces.context.effects.Effect
All known Subclasses: com.icesoft.faces.context.effects.Shake, com.icesoft.faces.context.effects.SlideUp, com.icesoft.faces.context.effects.Shrink, com.icesoft.faces.context.effects.BlankEffect, com.icesoft.faces.context.effects.BlindUp, com.icesoft.faces.context.effects.Puff, com.icesoft.faces.context.effects.Highlight, com.icesoft.faces.context.effects.Scale, com.icesoft.faces.context.effects.Move, com.icesoft.faces.context.effects.Pulsate, com.icesoft.faces.context.effects.Fade, com.icesoft.faces.context.effects.Appear, com.icesoft.faces.context.effects.BlindDown, com.icesoft.faces.context.effects.SlideDown, com.icesoft.faces.context.effects.SwitchOff, com.icesoft.faces.context.effects.Fold, com.icesoft.faces.context.effects.DropOut, com.icesoft.faces.context.effects.EffectQueue, com.icesoft.faces.context.effects.Grow, com.icesoft.faces.context.effects.Focus, com.icesoft.faces.context.effects.Squish, com.icesoft.faces.context.effects.Opacity,
| Effect | | abstract public class Effect (Code) | | Base class for all javascript effects
|
| getDelay | | public float getDelay()(Code) | | Gets the delay before invoking the effect
|
| getDuration | | public float getDuration()(Code) | | Get the duration of the effect (In seconds)
|
| getFps | | public float getFps()(Code) | | Get the frames per second of this effect
|
| getFrom | | public float getFrom()(Code) | | Gets the starting point of the transition, a float between 0.0 and 1.0.
Defaults to 0.0.
|
| getFunctionName | | abstract public String getFunctionName()(Code) | | get the name of the Function call to invoke the effect
|
| getId | | public String getId()(Code) | | Get the HTML ID of the element t
|
| getQueue | | public String getQueue()(Code) | | Gets queuing options. When used with a string, can be 'front' or 'end' to
queue the effect in the global effects queue at the beginning or end, or
a queue parameter object that can have {position:'front/end',
scope:'scope', limit:1}
|
| getSequence | | public String getSequence()(Code) | | Get the name of the sequence this effect is in
|
| getSequenceId | | public int getSequenceId()(Code) | | Get the ID or position of this effect in a sequence
|
| getTo | | public float getTo()(Code) | | Gets the end point of the transition, a float between 0.0 and 1.0.
Defaults to 1.0.
|
| hashCode | | public int hashCode()(Code) | | |
| isFired | | public boolean isFired()(Code) | | Has this effect been fired. ONly effects that have not been fired are
sent to the browser
|
| isQueueEnd | | public boolean isQueueEnd()(Code) | | |
| isQueued | | public boolean isQueued()(Code) | | |
| isSubmit | | public boolean isSubmit()(Code) | | Gets is this effect should fire partial submit when finished
|
| isSync | | public boolean isSync()(Code) | | Gets whether the effect should render new frames automatically (which it
does by default). If true, you can render frames manually by calling the
render() instance method of an effect. This is used by
Effect.Parallel().
|
| isTransitory | | public boolean isTransitory()(Code) | | Transitory effects return a component to its original state. This flag is
used to stop javascript from performing a partial submit at the end of an
effect.
Example highlight.
|
| setDelay | | public void setDelay(float delay)(Code) | | Sets the delay before invoking the effect
Parameters:
delay - |
| setDuration | | public void setDuration(float duration)(Code) | | Set the duration of the effect (In seconds)
Parameters:
duration - |
| setFired | | public void setFired(boolean fired)(Code) | | Set if this effect has been fired. When this flag is set to false
the effect will be sent to the browser on the next render pass.
After being fired Icefaces will set this flag to true. To resend this
effect set the flag to false.
Parameters:
fired - |
| setFps | | public void setFps(float fps)(Code) | | Set the frames per second of this effect. max is 25
Parameters:
fps - |
| setFrom | | public void setFrom(float from)(Code) | | Sets the starting point of the transition, a float between 0.0 and 1.0.
Defaults to 0.0.
Parameters:
from - |
| setId | | public void setId(String id)(Code) | | Set the HTML ID of the element t
Parameters:
id - |
| setQueue | | public void setQueue(String queue)(Code) | | Sets queuing options. When used with a string, can be 'front' or 'end' to
queue the effect in the global effects queue at the beginning or end, or
a queue parameter object that can have {position:'front/end',
scope:'scope', limit:1}
Parameters:
queue - |
| setQueueEnd | | public void setQueueEnd(boolean queueEnd)(Code) | |
Parameters:
queueEnd - |
| setQueued | | public void setQueued(boolean queued)(Code) | |
Parameters:
queued - |
| setSequence | | public void setSequence(String sequence)(Code) | | Set the name of the sequence this effect is in.
Parameters:
sequence - |
| setSequenceId | | public void setSequenceId(int sequenceId)(Code) | | Set the ID or position of this effect in a sequence
Parameters:
sequenceId - |
| setSubmit | | public void setSubmit(boolean submit)(Code) | | Sets is this effect should fire partial submit when finished.
Transitory also needs to be set to true.
default is false
Parameters:
submit - |
| setSync | | public void setSync(boolean sync)(Code) | | Sets whether the effect should render new frames automatically (which it
does by default). If true, you can render frames manually by calling the
render() instance method of an effect. This is used by
Effect.Parallel().
Parameters:
sync - |
| setTo | | public void setTo(float to)(Code) | | Sets the end point of the transition, a float between 0.0 and 1.0.
Defaults to 1.0.
Parameters:
to - |
| setTransitory | | public void setTransitory(boolean transitory)(Code) | | Transitory effects do not alter the display state. (Example: pulsate, shake)
However other effects change css style properties, and in some cases
the application needs to be aware of these changes. (For refreshing a page for example)
When css changes need to be sent to the application you need to set the transitory
property to false. The framework will then populate a hidden field with the new style
information. Ready to be sent on the next submit.
However, if you need to send the new style information immediately you need to set the submit attribute
to true as well. This will fire a partial submit at the end of the effect.
Default is true
Parameters:
transitory - true to not populate the css style changes, false to populate css style changes |
|
|