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:
java.util.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 java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static java.lang.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
 java.lang.String getAlign()
          HTML: Specifies the horizontal alignment of this element.
 java.lang.String getDatafld()
          Reserved for future use.
 java.lang.String getDataformatas()
          Reserved for future use.
 java.lang.String getDatasrc()
          Reserved for future use.
 java.lang.Boolean getDisplayValueOnly()
          If true, renders only the value of the component, but no input widget.
 java.lang.String getDisplayValueOnlyStyle()
          Style used when displayValueOnly is true.
 java.lang.String getDisplayValueOnlyStyleClass()
          Style class used when displayValueOnly is true.
 java.lang.String getEnabledOnUserRole()
          If user is in given role, this component will be rendered normally.
 java.lang.String getFamily()
           
 java.lang.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(java.lang.String align)
           
 void setDatafld(java.lang.String datafld)
           
 void setDataformatas(java.lang.String dataformatas)
           
 void setDatasrc(java.lang.String datasrc)
           
 void setDisplayValueOnly(java.lang.Boolean displayValueOnly)
           
 void setDisplayValueOnlyStyle(java.lang.String displayValueOnlyStyle)
           
 void setDisplayValueOnlyStyleClass(java.lang.String displayValueOnlyStyleClass)
           
 void setEnabledOnUserRole(java.lang.String enabledOnUserRole)
           
 void setForceId(boolean forceId)
           
 void setForceIdIndex(boolean forceIdIndex)
           
 void setVisibleOnUserRole(java.lang.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, getDir, getEventNames, getFooterClass, getFrame, getHeaderClass, getLang, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getRowClasses, getRules, getStyle, getStyleClass, getSummary, getTitle, getWidth, setBgcolor, setBodyrows, setBorder, setCaptionClass, setCaptionStyle, setCellpadding, setCellspacing, setColumnClasses, setColumns, setDir, setFooterClass, setFrame, setHeaderClass, setLang, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setRowClasses, setRules, setStyle, setStyleClass, setSummary, setTitle, setWidth
 
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, 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, setValueBinding, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, 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
addClientBehavior, getClientBehaviors, getDefaultEventName
 

Field Detail

COMPONENT_FAMILY

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

COMPONENT_TYPE

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

DEFAULT_RENDERER_TYPE

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

HtmlPanelGrid

public HtmlPanelGrid()
Method Detail

getFamily

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

getDisplayValueOnly

public java.lang.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(java.lang.Boolean displayValueOnly)

getDisplayValueOnlyStyle

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


setDisplayValueOnlyStyle

public void setDisplayValueOnlyStyle(java.lang.String displayValueOnlyStyle)

getDisplayValueOnlyStyleClass

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


setDisplayValueOnlyStyleClass

public void setDisplayValueOnlyStyleClass(java.lang.String displayValueOnlyStyleClass)

getEnabledOnUserRole

public java.lang.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(java.lang.String enabledOnUserRole)

getVisibleOnUserRole

public java.lang.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(java.lang.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 java.lang.String getDatafld()
Description copied from interface: DataProperties
Reserved for future use.


setDatafld

public void setDatafld(java.lang.String datafld)

getDatasrc

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


setDatasrc

public void setDatasrc(java.lang.String datasrc)

getDataformatas

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


setDataformatas

public void setDataformatas(java.lang.String dataformatas)

getAlign

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


setAlign

public void setAlign(java.lang.String align)


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