org.apache.myfaces.trinidadinternal.renderkit.core.xhtml.jsLibs
Class Scriptlet

java.lang.Object
  extended by org.apache.myfaces.trinidadinternal.renderkit.core.xhtml.jsLibs.Scriptlet
Direct Known Subclasses:
AliasedScriptlet, ColorFieldInfoScriptlet, ConfigurationScriptlet, GlobalVariablesScriptlet, JspDirScriptlet, LibraryScriptlet

public abstract class Scriptlet
extends java.lang.Object

Base class for Java code that is capable of adding scripts to a page.

Version:
$Name: $ ($Revision: adfrt/faces/adf-faces-impl/src/main/java/oracle/adfinternal/view/faces/renderkit/core/xhtml/jsLibs/Scriptlet.java#1 $) $Date: 11-nov-2005.14:59:39 $
Author:
The Oracle ADF Faces Team

Constructor Summary
Scriptlet()
          Creates the scriptlet.
 
Method Summary
 void embedInScriptTag(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc)
           
protected  void embedInScriptTagImpl(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc)
          Outputs the scriptlet.
abstract  java.lang.Object getScriptletKey()
          Returns the key that uniquely identifies the scriptlet.
protected  void outputDependency(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, java.lang.Object dependency)
          Outputs a scriptlet that this scriptlet depends on.
 void outputScriptlet(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc)
          Outputs the scriptlet if needed.
protected abstract  void outputScriptletContent(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc)
          Outputs the content of the scriptlet - the text or attributes between the script elements.
protected  void outputScriptletImpl(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc)
          Outputs the scriptlet.
 void registerSelf()
          Registers the scriptlet.
 void registerSelfWithKey(java.lang.Object key)
          Registers a scriptlet with a key, perhaps other than the scriptlet's own key.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Scriptlet

public Scriptlet()
Creates the scriptlet.

Method Detail

getScriptletKey

public abstract java.lang.Object getScriptletKey()
Returns the key that uniquely identifies the scriptlet.


outputScriptlet

public void outputScriptlet(javax.faces.context.FacesContext context,
                            org.apache.myfaces.trinidad.context.RenderingContext arc)
                     throws java.io.IOException
Outputs the scriptlet if needed. If the scriptlet is unnecessary (or has already been output), this is a no-op.

Throws:
java.io.IOException

registerSelf

public void registerSelf()
Registers the scriptlet.


embedInScriptTag

public void embedInScriptTag(javax.faces.context.FacesContext context,
                             org.apache.myfaces.trinidad.context.RenderingContext arc)
                      throws java.io.IOException
Throws:
java.io.IOException

outputScriptletImpl

protected void outputScriptletImpl(javax.faces.context.FacesContext context,
                                   org.apache.myfaces.trinidad.context.RenderingContext arc)
                            throws java.io.IOException
Outputs the scriptlet.

Throws:
java.io.IOException

embedInScriptTagImpl

protected void embedInScriptTagImpl(javax.faces.context.FacesContext context,
                                    org.apache.myfaces.trinidad.context.RenderingContext arc)
                             throws java.io.IOException
Outputs the scriptlet.

Throws:
java.io.IOException

outputScriptletContent

protected abstract void outputScriptletContent(javax.faces.context.FacesContext context,
                                               org.apache.myfaces.trinidad.context.RenderingContext arc)
                                        throws java.io.IOException
Outputs the content of the scriptlet - the text or attributes between the script elements.

Throws:
java.io.IOException

outputDependency

protected void outputDependency(javax.faces.context.FacesContext context,
                                org.apache.myfaces.trinidad.context.RenderingContext arc,
                                java.lang.Object dependency)
                         throws java.io.IOException
Outputs a scriptlet that this scriptlet depends on.

Throws:
java.io.IOException

registerSelfWithKey

public void registerSelfWithKey(java.lang.Object key)
Registers a scriptlet with a key, perhaps other than the scriptlet's own key.



Copyright © 2001-2007 Apache Software Foundation. All Rights Reserved.