org.apache.myfaces.component.html.ext
Class HtmlPanelGrid

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIPanel
              extended by javax.faces.component.html.HtmlPanelGrid
                  extended by org.apache.myfaces.component.html.ext.AbstractHtmlPanelGrid
                      extended by org.apache.myfaces.component.html.ext.HtmlPanelGrid
All Implemented Interfaces:
EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, AlignProperty, DataProperties, DisplayValueOnlyAware, ForceIdAware, UserRoleAware, DisplayValueOnlyCapable

public class HtmlPanelGrid
extends AbstractHtmlPanelGrid


Nested Class Summary
protected static class HtmlPanelGrid.PropertyKeys
           
 
Field Summary
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
static String DEFAULT_RENDERER_TYPE
           
 
Fields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
 
Fields inherited from interface org.apache.myfaces.component.UserRoleAware
ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR
 
Fields inherited from interface org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable
DISPLAY_VALUE_ONLY_ATTR, DISPLAY_VALUE_ONLY_STYLE_ATTR, DISPLAY_VALUE_ONLY_STYLE_CLASS_ATTR
 
Constructor Summary
HtmlPanelGrid()
           
 
Method Summary
 void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
           
 String getAlign()
          HTML: Specifies the horizontal alignment of this element.
 String getDatafld()
          Reserved for future use.
 String getDataformatas()
          Reserved for future use.
 String getDatasrc()
          Reserved for future use.
 String getDir()
           
 Boolean getDisplayValueOnly()
          If true, renders only the value of the component, but no input widget.
 String getDisplayValueOnlyStyle()
          Style used when displayValueOnly is true.
 String getDisplayValueOnlyStyleClass()
          Style class used when displayValueOnly is true.
 String getEnabledOnUserRole()
          If user is in given role, this component will be rendered normally.
 String getFamily()
           
 String getLang()
           
 String getOnclick()
           
 String getOndblclick()
           
 String getOnkeydown()
           
 String getOnkeypress()
           
 String getOnkeyup()
           
 String getOnmousedown()
           
 String getOnmousemove()
           
 String getOnmouseout()
           
 String getOnmouseover()
           
 String getOnmouseup()
           
 String getStyle()
           
 String getStyleClass()
           
 String getTitle()
           
 String getVisibleOnUserRole()
          If user is in given role, this component will be rendered normally.
 boolean isForceId()
          If true, this component will force the use of the specified id when rendering.
 boolean isForceIdIndex()
          If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)
 void setAlign(String align)
           
 void setDatafld(String datafld)
           
 void setDataformatas(String dataformatas)
           
 void setDatasrc(String datasrc)
           
 void setDir(String dir)
           
 void setDisplayValueOnly(Boolean displayValueOnly)
           
 void setDisplayValueOnlyStyle(String displayValueOnlyStyle)
           
 void setDisplayValueOnlyStyleClass(String displayValueOnlyStyleClass)
           
 void setEnabledOnUserRole(String enabledOnUserRole)
           
 void setForceId(boolean forceId)
           
 void setForceIdIndex(boolean forceIdIndex)
           
 void setLang(String lang)
           
 void setOnclick(String onclick)
           
 void setOndblclick(String ondblclick)
           
 void setOnkeydown(String onkeydown)
           
 void setOnkeypress(String onkeypress)
           
 void setOnkeyup(String onkeyup)
           
 void setOnmousedown(String onmousedown)
           
 void setOnmousemove(String onmousemove)
           
 void setOnmouseout(String onmouseout)
           
 void setOnmouseover(String onmouseover)
           
 void setOnmouseup(String onmouseup)
           
 void setStyle(String style)
           
 void setStyleClass(String styleClass)
           
 void setTitle(String title)
           
 void setValueBinding(String name, javax.faces.el.ValueBinding binding)
           
 void setValueExpression(String name, javax.el.ValueExpression expression)
           
 void setVisibleOnUserRole(String visibleOnUserRole)
           
 
Methods inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlPanelGrid
getClientId, isDisplayValueOnly, isRendered, isSetDisplayValueOnly, setDisplayValueOnly
 
Methods inherited from class javax.faces.component.html.HtmlPanelGrid
getBgcolor, getBodyrows, getBorder, getCaptionClass, getCaptionStyle, getCellpadding, getCellspacing, getColumnClasses, getColumns, getEventNames, getFooterClass, getFrame, getHeaderClass, getRowClasses, getRules, getSummary, getWidth, setBgcolor, setBodyrows, setBorder, setCaptionClass, setCaptionStyle, setCellpadding, setCellspacing, setColumnClasses, setColumns, setFooterClass, setFrame, setHeaderClass, setRowClasses, setRules, setSummary, setWidth
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getDefaultEventName, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, subscribeToEvent, unsubscribeFromEvent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors, getDefaultEventName
 

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values

DEFAULT_RENDERER_TYPE

public static final String DEFAULT_RENDERER_TYPE
See Also:
Constant Field Values
Constructor Detail

HtmlPanelGrid

public HtmlPanelGrid()
Method Detail

getFamily

public String getFamily()
Overrides:
getFamily in class javax.faces.component.html.HtmlPanelGrid

addClientBehavior

public void addClientBehavior(String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)
Specified by:
addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
addClientBehavior in class javax.faces.component.html.HtmlPanelGrid

getDisplayValueOnly

public Boolean getDisplayValueOnly()
Description copied from interface: DisplayValueOnlyAware
If true, renders only the value of the component, but no input widget. Default is false.


setDisplayValueOnly

public void setDisplayValueOnly(Boolean displayValueOnly)

getDisplayValueOnlyStyle

public String getDisplayValueOnlyStyle()
Description copied from interface: DisplayValueOnlyAware
Style used when displayValueOnly is true.


setDisplayValueOnlyStyle

public void setDisplayValueOnlyStyle(String displayValueOnlyStyle)

getDisplayValueOnlyStyleClass

public String getDisplayValueOnlyStyleClass()
Description copied from interface: DisplayValueOnlyAware
Style class used when displayValueOnly is true.


setDisplayValueOnlyStyleClass

public void setDisplayValueOnlyStyleClass(String displayValueOnlyStyleClass)

getEnabledOnUserRole

public String getEnabledOnUserRole()
Description copied from interface: UserRoleAware
If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.

Returns:

setEnabledOnUserRole

public void setEnabledOnUserRole(String enabledOnUserRole)

getVisibleOnUserRole

public String getVisibleOnUserRole()
Description copied from interface: UserRoleAware
If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.

Returns:

setVisibleOnUserRole

public void setVisibleOnUserRole(String visibleOnUserRole)

isForceId

public boolean isForceId()
Description copied from interface: ForceIdAware
If true, this component will force the use of the specified id when rendering.

Returns:

setForceId

public void setForceId(boolean forceId)

isForceIdIndex

public boolean isForceIdIndex()
Description copied from interface: ForceIdAware
If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)

Returns:

setForceIdIndex

public void setForceIdIndex(boolean forceIdIndex)

getDatafld

public String getDatafld()
Description copied from interface: DataProperties
Reserved for future use.


setDatafld

public void setDatafld(String datafld)

getDatasrc

public String getDatasrc()
Description copied from interface: DataProperties
Reserved for future use.


setDatasrc

public void setDatasrc(String datasrc)

getDataformatas

public String getDataformatas()
Description copied from interface: DataProperties
Reserved for future use.


setDataformatas

public void setDataformatas(String dataformatas)

getAlign

public String getAlign()
Description copied from interface: AlignProperty
HTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01.


setAlign

public void setAlign(String align)

getStyle

public String getStyle()
Overrides:
getStyle in class javax.faces.component.html.HtmlPanelGrid

setStyle

public void setStyle(String style)
Overrides:
setStyle in class javax.faces.component.html.HtmlPanelGrid

getStyleClass

public String getStyleClass()
Overrides:
getStyleClass in class javax.faces.component.html.HtmlPanelGrid

setStyleClass

public void setStyleClass(String styleClass)
Overrides:
setStyleClass in class javax.faces.component.html.HtmlPanelGrid

getOnclick

public String getOnclick()
Overrides:
getOnclick in class javax.faces.component.html.HtmlPanelGrid

setOnclick

public void setOnclick(String onclick)
Overrides:
setOnclick in class javax.faces.component.html.HtmlPanelGrid

getOndblclick

public String getOndblclick()
Overrides:
getOndblclick in class javax.faces.component.html.HtmlPanelGrid

setOndblclick

public void setOndblclick(String ondblclick)
Overrides:
setOndblclick in class javax.faces.component.html.HtmlPanelGrid

getOnkeydown

public String getOnkeydown()
Overrides:
getOnkeydown in class javax.faces.component.html.HtmlPanelGrid

setOnkeydown

public void setOnkeydown(String onkeydown)
Overrides:
setOnkeydown in class javax.faces.component.html.HtmlPanelGrid

getOnkeypress

public String getOnkeypress()
Overrides:
getOnkeypress in class javax.faces.component.html.HtmlPanelGrid

setOnkeypress

public void setOnkeypress(String onkeypress)
Overrides:
setOnkeypress in class javax.faces.component.html.HtmlPanelGrid

getOnkeyup

public String getOnkeyup()
Overrides:
getOnkeyup in class javax.faces.component.html.HtmlPanelGrid

setOnkeyup

public void setOnkeyup(String onkeyup)
Overrides:
setOnkeyup in class javax.faces.component.html.HtmlPanelGrid

getOnmousedown

public String getOnmousedown()
Overrides:
getOnmousedown in class javax.faces.component.html.HtmlPanelGrid

setOnmousedown

public void setOnmousedown(String onmousedown)
Overrides:
setOnmousedown in class javax.faces.component.html.HtmlPanelGrid

getOnmousemove

public String getOnmousemove()
Overrides:
getOnmousemove in class javax.faces.component.html.HtmlPanelGrid

setOnmousemove

public void setOnmousemove(String onmousemove)
Overrides:
setOnmousemove in class javax.faces.component.html.HtmlPanelGrid

getOnmouseout

public String getOnmouseout()
Overrides:
getOnmouseout in class javax.faces.component.html.HtmlPanelGrid

setOnmouseout

public void setOnmouseout(String onmouseout)
Overrides:
setOnmouseout in class javax.faces.component.html.HtmlPanelGrid

getOnmouseover

public String getOnmouseover()
Overrides:
getOnmouseover in class javax.faces.component.html.HtmlPanelGrid

setOnmouseover

public void setOnmouseover(String onmouseover)
Overrides:
setOnmouseover in class javax.faces.component.html.HtmlPanelGrid

getOnmouseup

public String getOnmouseup()
Overrides:
getOnmouseup in class javax.faces.component.html.HtmlPanelGrid

setOnmouseup

public void setOnmouseup(String onmouseup)
Overrides:
setOnmouseup in class javax.faces.component.html.HtmlPanelGrid

getDir

public String getDir()
Overrides:
getDir in class javax.faces.component.html.HtmlPanelGrid

setDir

public void setDir(String dir)
Overrides:
setDir in class javax.faces.component.html.HtmlPanelGrid

getLang

public String getLang()
Overrides:
getLang in class javax.faces.component.html.HtmlPanelGrid

setLang

public void setLang(String lang)
Overrides:
setLang in class javax.faces.component.html.HtmlPanelGrid

getTitle

public String getTitle()
Overrides:
getTitle in class javax.faces.component.html.HtmlPanelGrid

setTitle

public void setTitle(String title)
Overrides:
setTitle in class javax.faces.component.html.HtmlPanelGrid

setValueBinding

public void setValueBinding(String name,
                            javax.faces.el.ValueBinding binding)
Overrides:
setValueBinding in class javax.faces.component.html.HtmlPanelGrid

setValueExpression

public void setValueExpression(String name,
                               javax.el.ValueExpression expression)
Overrides:
setValueExpression in class javax.faces.component.html.HtmlPanelGrid


Copyright © 2012 The Apache Software Foundation. All Rights Reserved.