org.apache.myfaces.tobago.taglib.component
Class PageTag

java.lang.Object
  extended by javax.faces.webapp.UIComponentTag
      extended by org.apache.myfaces.tobago.taglib.component.TobagoTag
          extended by org.apache.myfaces.tobago.taglib.component.TobagoBodyTag
              extended by org.apache.myfaces.tobago.taglib.component.PageTag
All Implemented Interfaces:
BodyTag, IterationTag, JspTag, Tag, PageTagDeclaration, TobagoBodyTagDeclaration, TobagoTagDeclaration, HasBinding, HasDimension, HasHeight, HasId, HasLabel, HasState, HasWidth

public class PageTag
extends TobagoBodyTag
implements BodyTag, PageTagDeclaration


Field Summary
 
Fields inherited from class javax.faces.webapp.UIComponentTag
pageContext
 
Constructor Summary
PageTag()
           
 
Method Summary
 int doEndTag()
           
 java.lang.String getApplicationIcon()
           
 java.lang.String getComponentType()
           
 java.lang.String getFocusId()
           
 java.lang.String getHeight()
           
 java.lang.String getLabel()
           
 java.lang.String getWidth()
           
 void release()
           
 void setApplicationIcon(java.lang.String icon)
          Absolute URL to an image or image name to lookup in tobago resource path representing the application.
 void setDoctype(java.lang.String doctype)
          Possible values for doctype are: strictHTML 4.01 Strict DTD looseHTML 4.01 Transitional DTD framesetHTML 4.01 Frameset DTD All other values are ignored and no DOCTYPE is set.
 void setFocusId(java.lang.String focusId)
          Contains the id of the component wich should have the focus after loading the page.
 void setHeight(java.lang.String height)
          The height for this component.
 void setLabel(java.lang.String label)
          Text value to display as label.
 void setMethod(java.lang.String method)
           
protected  void setProperties(UIComponent component)
           
 void setState(java.lang.String state)
          ValueBindingExpression pointing to a object to save the component's state.
 void setWidth(java.lang.String width)
          The width for this component.
 
Methods inherited from class org.apache.myfaces.tobago.taglib.component.TobagoBodyTag
doAfterBody, doInitBody, getDoAfterBodyValue, getDoStartValue, isBodyContentEmpty, setBodyContent
 
Methods inherited from class org.apache.myfaces.tobago.taglib.component.TobagoTag
doStartTag, getDisabled, getHidden, getInline, getReadonly, getRendererType, getTitle, setDisabled, setHidden, setInline, setReadonly, setTitle
 
Methods inherited from class javax.faces.webapp.UIComponentTag
encodeBegin, encodeChildren, encodeEnd, findComponent, getComponentInstance, getCreated, getDoEndValue, getFacesContext, getFacetName, getId, getParent, getParentUIComponentTag, isSuppressed, isValueReference, setBinding, setId, setPageContext, setParent, setRendered, setupResponseWriter
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.myfaces.tobago.taglib.decl.HasId
setId
 
Methods inherited from interface org.apache.myfaces.tobago.taglib.decl.HasBinding
setBinding
 

Constructor Detail

PageTag

public PageTag()
Method Detail

doEndTag

public int doEndTag()
             throws JspException
Specified by:
doEndTag in interface Tag
Overrides:
doEndTag in class TobagoBodyTag
Throws:
JspException

getComponentType

public java.lang.String getComponentType()
Specified by:
getComponentType in class UIComponentTag

release

public void release()
Specified by:
release in interface Tag
Overrides:
release in class TobagoBodyTag

setProperties

protected void setProperties(UIComponent component)
Overrides:
setProperties in class TobagoTag

setDoctype

public void setDoctype(java.lang.String doctype)
Description copied from interface: PageTagDeclaration
Possible values for doctype are:
strict
HTML 4.01 Strict DTD
loose
HTML 4.01 Transitional DTD
frameset
HTML 4.01 Frameset DTD
All other values are ignored and no DOCTYPE is set.

Specified by:
setDoctype in interface PageTagDeclaration

setMethod

public void setMethod(java.lang.String method)

setState

public void setState(java.lang.String state)
Description copied from interface: HasState
ValueBindingExpression pointing to a object to save the component's state.

Specified by:
setState in interface HasState

getFocusId

public java.lang.String getFocusId()

setFocusId

public void setFocusId(java.lang.String focusId)
Description copied from interface: PageTagDeclaration
Contains the id of the component wich should have the focus after loading the page. Set to emtpy string for disabling setting of focus. Default (null) enables the "auto focus" feature.

Specified by:
setFocusId in interface PageTagDeclaration

getLabel

public java.lang.String getLabel()
Overrides:
getLabel in class TobagoTag

setLabel

public void setLabel(java.lang.String label)
Description copied from interface: HasLabel
Text value to display as label. If text contains an underscore the next character is used as accesskey.

Specified by:
setLabel in interface HasLabel
Overrides:
setLabel in class TobagoTag

getWidth

public java.lang.String getWidth()
Overrides:
getWidth in class TobagoTag

setWidth

public void setWidth(java.lang.String width)
Description copied from interface: HasWidth
The width for this component. This value is used in the gridLayouts columns attribute. See gridLayout tag for valid values.

Specified by:
setWidth in interface HasWidth
Overrides:
setWidth in class TobagoTag

getHeight

public java.lang.String getHeight()
Overrides:
getHeight in class TobagoTag

setHeight

public void setHeight(java.lang.String height)
Description copied from interface: HasHeight
The height for this component.

Specified by:
setHeight in interface HasHeight
Overrides:
setHeight in class TobagoTag

setApplicationIcon

public void setApplicationIcon(java.lang.String icon)
Description copied from interface: PageTagDeclaration
Absolute URL to an image or image name to lookup in tobago resource path representing the application. In HTML it is used as a favicon.

Specified by:
setApplicationIcon in interface PageTagDeclaration

getApplicationIcon

public java.lang.String getApplicationIcon()


Copyright © 2002-2013 The Apache Software Foundation. All Rights Reserved.