org.ajax4jsf.component.html
Class Include

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by org.ajax4jsf.component.UIInclude
              extended by org.ajax4jsf.component.html.Include
All Implemented Interfaces:
javax.faces.component.NamingContainer, javax.faces.component.StateHolder, org.ajax4jsf.component.AjaxOutput, org.ajax4jsf.context.ViewIdHolder

public class Include
extends UIInclude

Component-Type org.ajax4jsf.Include Component-Family javax.faces.Output Renderer-Type org.ajax4jsf.components.AjaxIncludeRenderer include content of external view. Navigation cases in included file change only viewId of included page, and don't perform navigation in root view.


Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from class org.ajax4jsf.component.UIInclude
LAYOUT_BLOCK, LAYOUT_INLINE, LAYOUT_NONE
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
Include()
          Constructor to init default renderers
 
Method Summary
 java.lang.String getDir()
          Direction indication for text that does not inherit directionality.
 java.lang.String getFamily()
           
 java.lang.String getLang()
          Code describing the language used in the generated markup for this component Getter for lang
 java.lang.String getStyle()
          CSS style(s) is/are to be applied when this component is rendered Getter for style
 java.lang.String getStyleClass()
          Corresponds to the HTML class attribute Getter for styleClass
 java.lang.String getTitle()
          Advisory title information about markup elements generated for this component Getter for title
 boolean isKeepTransient()
          Flag for mark all child components to non-transient.
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setDir(java.lang.String __dir)
          Direction indication for text that does not inherit directionality.
 void setKeepTransient(boolean __keepTransient)
          Flag for mark all child components to non-transient.
 void setLang(java.lang.String __lang)
          Code describing the language used in the generated markup for this component Setter for lang
 void setStyle(java.lang.String __style)
          CSS style(s) is/are to be applied when this component is rendered Setter for style
 void setStyleClass(java.lang.String __styleClass)
          Corresponds to the HTML class attribute Setter for styleClass
 void setTitle(java.lang.String __title)
          Advisory title information about markup elements generated for this component Setter for title
 
Methods inherited from class org.ajax4jsf.component.UIInclude
broadcast, getLayout, getViewId, isAjaxRendered, isWasNavigation, processDecodes, processUpdates, processValidators, queueEvent, setAjaxRendered, setLayout, setViewId, skipNavigation
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_TYPE

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

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values
Constructor Detail

Include

public Include()
Constructor to init default renderers

Method Detail

setLang

public void setLang(java.lang.String __lang)
Code describing the language used in the generated markup for this component Setter for lang

Parameters:
lang - - new value

getLang

public java.lang.String getLang()
Code describing the language used in the generated markup for this component Getter for lang

Returns:
lang value from local variable or value bindings

setTitle

public void setTitle(java.lang.String __title)
Advisory title information about markup elements generated for this component Setter for title

Parameters:
title - - new value

getTitle

public java.lang.String getTitle()
Advisory title information about markup elements generated for this component Getter for title

Returns:
title value from local variable or value bindings

setDir

public void setDir(java.lang.String __dir)
Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left) Setter for dir

Parameters:
dir - - new value

getDir

public java.lang.String getDir()
Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left) Getter for dir

Returns:
dir value from local variable or value bindings

setStyleClass

public void setStyleClass(java.lang.String __styleClass)
Corresponds to the HTML class attribute Setter for styleClass

Parameters:
styleClass - - new value

getStyleClass

public java.lang.String getStyleClass()
Corresponds to the HTML class attribute Getter for styleClass

Returns:
styleClass value from local variable or value bindings

setKeepTransient

public void setKeepTransient(boolean __keepTransient)
Flag for mark all child components to non-transient. If true, all children components will be set to non-transient state and keep in saved components tree. For output in self-renderer region all content ( By default, all content in <f:verbatim> tags and non-jsf elements in facelets, marked as transient - since, self-rendered ajax regions don't plain output for ajax processing ). Setter for keepTransient

Parameters:
keepTransient - - new value

isKeepTransient

public boolean isKeepTransient()
Flag for mark all child components to non-transient. If true, all children components will be set to non-transient state and keep in saved components tree. For output in self-renderer region all content ( By default, all content in <f:verbatim> tags and non-jsf elements in facelets, marked as transient - since, self-rendered ajax regions don't plain output for ajax processing ). Getter for keepTransient

Returns:
keepTransient value from local variable or value bindings

setStyle

public void setStyle(java.lang.String __style)
CSS style(s) is/are to be applied when this component is rendered Setter for style

Parameters:
style - - new value

getStyle

public java.lang.String getStyle()
CSS style(s) is/are to be applied when this component is rendered Getter for style

Returns:
style value from local variable or value bindings

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class UIInclude

saveState

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

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 UIInclude


Copyright © 2007. All Rights Reserved.