com.ibm.xsp.resource
Class DojoModuleResource

java.lang.Object
  extended by com.ibm.xsp.complex.ValueBindingObjectImpl
      extended by com.ibm.xsp.resource.AbstractResource
          extended by com.ibm.xsp.resource.DojoModuleResource
All Implemented Interfaces:
ComponentBindingObject, EncodableObject, ValueBindingObject, Resource, javax.faces.component.StateHolder

public class DojoModuleResource
extends AbstractResource
implements EncodableObject

Corresponds to the xp:dojoModule tag which is used to output dojo modules that are needed at runtime


Field Summary
static DojoModuleResource DOJO_PARSER
          A dojo module resource for the module "dojo.parser"
static java.lang.String RENDERER_TYPE
           
static DojoModuleResource XSP_CLIENT_DOJO_UI
          Deprecated.  
 
Fields inherited from class com.ibm.xsp.resource.AbstractResource
FAMILY
 
Constructor Summary
DojoModuleResource()
          Default Constructor
DojoModuleResource(java.lang.String name)
          Default Constructor
 
Method Summary
 java.lang.String getCondition()
          Client side JavaScript expression that defines the condition for including this module.
 java.lang.String getName()
          Returns the dojo module you want to load
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setCondition(java.lang.String condition)
          Sets the module condition which can be javascript expression for example it can be dojo.isIE
 void setName(java.lang.String name)
          The dojo module name to set.
 java.lang.String toString()
           
 
Methods inherited from class com.ibm.xsp.resource.AbstractResource
encodeObject, equals, getFamily, getRendererType, getServerResourceContents, getUniqueId, isRendered, loadContents, setRendered, setRendererType
 
Methods inherited from class com.ibm.xsp.complex.ValueBindingObjectImpl
getComponent, getFacesContext, getValueBinding, isTransient, setComponent, setTransient, setValueBinding
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.xsp.complex.EncodableObject
encodeObject
 

Field Detail

RENDERER_TYPE

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

DOJO_PARSER

public static final DojoModuleResource DOJO_PARSER
A dojo module resource for the module "dojo.parser"


XSP_CLIENT_DOJO_UI

public static final DojoModuleResource XSP_CLIENT_DOJO_UI
Deprecated. 
A dojo module resource for the module "ibm.xsp.widget.layout.xspClientUI"

Constructor Detail

DojoModuleResource

public DojoModuleResource()
Default Constructor


DojoModuleResource

public DojoModuleResource(java.lang.String name)
Default Constructor

Parameters:
name - of the module resource
Method Detail

getName

public java.lang.String getName()
Returns the dojo module you want to load

Returns:
Returns the dojo module name.

setName

public void setName(java.lang.String name)
The dojo module name to set.

Parameters:
name -

getCondition

public java.lang.String getCondition()
Client side JavaScript expression that defines the condition for including this module. For example, it can be dojo.isIE

Returns:
Returns the module condition.

setCondition

public void setCondition(java.lang.String condition)
Sets the module condition which can be javascript expression for example it can be dojo.isIE

Parameters:
condition -

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class AbstractResource

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class AbstractResource

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object