Home » Mojarra-2.0.1 » javax » faces » component » html » [javadoc | source]
javax.faces.component.html
public class: HtmlDataTable [javadoc | source]
java.lang.Object
   javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
         javax.faces.component.UIData
            javax.faces.component.html.HtmlDataTable

All Implemented Interfaces:
    ClientBehaviorHolder, UniqueIdVendor, NamingContainer, PartialStateHolder, ComponentSystemEventListener, SystemEventListenerHolder

Represents a set of repeating data (segregated into columns by child UIColumn components) that will be rendered in an HTML table element.

By default, the rendererType property must be set to "javax.faces.Table". This value can be changed by calling the setRendererType() method.

Nested Class Summary:
protected enum class  HtmlDataTable.PropertyKeys   
Field Summary
public static final  String COMPONENT_TYPE   

The standard component type for this component.

 
Fields inherited from javax.faces.component.UIData:
COMPONENT_TYPE,  COMPONENT_FAMILY
Fields inherited from javax.faces.component.UIComponent:
CURRENT_COMPONENT,  CURRENT_COMPOSITE_COMPONENT,  BEANINFO_KEY,  FACETS_KEY,  VIEW_LOCATION_KEY,  COMPOSITE_COMPONENT_TYPE_KEY,  COMPOSITE_FACET_NAME,  attributesThatAreSet,  stateHelper,  compositeParent,  bindings,  initialState,  listenersByEventClass
Constructor:
 public HtmlDataTable() 
Method from javax.faces.component.html.HtmlDataTable Summary:
getBgcolor,   getBodyrows,   getBorder,   getCaptionClass,   getCaptionStyle,   getCellpadding,   getCellspacing,   getColumnClasses,   getDefaultEventName,   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,   setDir,   setFooterClass,   setFrame,   setHeaderClass,   setLang,   setOnclick,   setOndblclick,   setOnkeydown,   setOnkeypress,   setOnkeyup,   setOnmousedown,   setOnmousemove,   setOnmouseout,   setOnmouseover,   setOnmouseup,   setRowClasses,   setRules,   setStyle,   setStyleClass,   setSummary,   setTitle,   setWidth
Methods from javax.faces.component.UIData:
broadcast,   createUniqueId,   encodeBegin,   getClientId,   getDataModel,   getFamily,   getFirst,   getFooter,   getHeader,   getRowCount,   getRowData,   getRowIndex,   getRows,   getValue,   getVar,   invokeOnComponent,   isRowAvailable,   processDecodes,   processUpdates,   processValidators,   queueEvent,   setDataModel,   setFirst,   setFooter,   setHeader,   setRowIndex,   setRows,   setValue,   setValueBinding,   setValueExpression,   setVar,   visitTree
Methods from javax.faces.component.UIComponentBase:
addClientBehavior,   addFacesListener,   broadcast,   clearInitialState,   decode,   encodeBegin,   encodeChildren,   encodeEnd,   findComponent,   getAttributes,   getChildCount,   getChildren,   getClientBehaviors,   getClientId,   getDefaultEventName,   getDescriptorMap,   getEventNames,   getFacesContext,   getFacesListeners,   getFacet,   getFacetCount,   getFacets,   getFacetsAndChildren,   getId,   getParent,   getRenderer,   getRendererType,   getRendersChildren,   getValueBinding,   invokeOnComponent,   isRendered,   isTransient,   markInitialState,   processDecodes,   processRestoreState,   processSaveState,   processUpdates,   processValidators,   queueEvent,   removeFacesListener,   restoreAttachedState,   restoreState,   saveAttachedState,   saveState,   setId,   setParent,   setRendered,   setRendererType,   setTransient,   setValueBinding
Methods from javax.faces.component.UIComponent:
addFacesListener,   broadcast,   clearInitialState,   decode,   encodeAll,   encodeBegin,   encodeChildren,   encodeEnd,   findComponent,   getAttributes,   getChildCount,   getChildren,   getClientId,   getClientId,   getCompositeComponentParent,   getContainerClientId,   getCurrentComponent,   getCurrentCompositeComponent,   getFacesContext,   getFacesListeners,   getFacet,   getFacetCount,   getFacets,   getFacetsAndChildren,   getFamily,   getId,   getListenersForEventClass,   getNamingContainer,   getParent,   getRenderer,   getRendererType,   getRendersChildren,   getResourceBundleMap,   getStateHelper,   getStateHelper,   getValueBinding,   getValueExpression,   initialStateMarked,   invokeOnComponent,   isCompositeComponent,   isInView,   isRendered,   isVisitable,   markInitialState,   popComponentFromEL,   processDecodes,   processEvent,   processRestoreState,   processSaveState,   processUpdates,   processValidators,   pushComponentToEL,   queueEvent,   removeFacesListener,   setId,   setInView,   setParent,   setRendered,   setRendererType,   setValueBinding,   setValueExpression,   subscribeToEvent,   unsubscribeFromEvent,   visitTree
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.faces.component.html.HtmlDataTable Detail:
 public String getBgcolor() 

    Return the value of the bgcolor property.

    Contents: Name or code of the background color for this table.

 public String getBodyrows() 

    Return the value of the bodyrows property.

    Contents: Comma separated list of row indices for which a new "tbody" element should be started (and any previously opened one should be ended).

 public int getBorder() 

    Return the value of the border property.

    Contents: Width (in pixels) of the border to be drawn around this table.

 public String getCaptionClass() 

    Return the value of the captionClass property.

    Contents: Space-separated list of CSS style class(es) that will be applied to any caption generated for this table.

 public String getCaptionStyle() 

    Return the value of the captionStyle property.

    Contents: CSS style(s) to be applied when this caption is rendered.

 public String getCellpadding() 

    Return the value of the cellpadding property.

    Contents: Definition of how much space the user agent should leave between the border of each cell and its contents.

 public String getCellspacing() 

    Return the value of the cellspacing property.

    Contents: Definition of how much space the user agent should leave between the left side of the table and the leftmost column, the top of the table and the top of the top side of the topmost row, and so on for the right and bottom of the table. It also specifies the amount of space to leave between cells.

 public String getColumnClasses() 

    Return the value of the columnClasses property.

    Contents: Comma-delimited list of CSS style classes that will be applied to the columns of this table. A space separated list of classes may also be specified for any individual column. If the number of elements in this list is less than the number of actual column children of the UIData, no "class" attribute is output for each column greater than the number of elements in the list. If the number of elements in the list is greater than the number of actual column children of the UIData, the elements at the posisiton in the list after the last column are ignored.

 public String getDefaultEventName() 
 public String getDir() 

    Return the value of the dir property.

    Contents: Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).

 public Collection<String> getEventNames() 
 public String getFooterClass() 

    Return the value of the footerClass property.

    Contents: Space-separated list of CSS style class(es) that will be applied to any footer generated for this table.

 public String getFrame() 

    Return the value of the frame property.

    Contents: Code specifying which sides of the frame surrounding this table will be visible. Valid values are: none (no sides, default value); above (top side only); below (bottom side only); hsides (top and bottom sides only); vsides (right and left sides only); lhs (left hand side only); rhs (right hand side only); box (all four sides); and border (all four sides).

 public String getHeaderClass() 

    Return the value of the headerClass property.

    Contents: Space-separated list of CSS style class(es) that will be applied to any header generated for this table.

 public String getLang() 

    Return the value of the lang property.

    Contents: Code describing the language used in the generated markup for this component.

 public String getOnclick() 

    Return the value of the onclick property.

    Contents: Javascript code executed when a pointer button is clicked over this element.

 public String getOndblclick() 

    Return the value of the ondblclick property.

    Contents: Javascript code executed when a pointer button is double clicked over this element.

 public String getOnkeydown() 

    Return the value of the onkeydown property.

    Contents: Javascript code executed when a key is pressed down over this element.

 public String getOnkeypress() 

    Return the value of the onkeypress property.

    Contents: Javascript code executed when a key is pressed and released over this element.

 public String getOnkeyup() 

    Return the value of the onkeyup property.

    Contents: Javascript code executed when a key is released over this element.

 public String getOnmousedown() 

    Return the value of the onmousedown property.

    Contents: Javascript code executed when a pointer button is pressed down over this element.

 public String getOnmousemove() 

    Return the value of the onmousemove property.

    Contents: Javascript code executed when a pointer button is moved within this element.

 public String getOnmouseout() 

    Return the value of the onmouseout property.

    Contents: Javascript code executed when a pointer button is moved away from this element.

 public String getOnmouseover() 

    Return the value of the onmouseover property.

    Contents: Javascript code executed when a pointer button is moved onto this element.

 public String getOnmouseup() 

    Return the value of the onmouseup property.

    Contents: Javascript code executed when a pointer button is released over this element.

 public String getRowClasses() 

    Return the value of the rowClasses property.

    Contents: Comma-delimited list of CSS style classes that will be applied to the rows of this table. A space separated list of classes may also be specified for any individual row. Thes styles are applied, in turn, to each row in the table. For example, if the list has two elements, the first style class in the list is applied to the first row, the second to the second row, the first to the third row, the second to the fourth row, etc. In other words, we keep iterating through the list until we reach the end, and then we start at the beginning again.

 public String getRules() 

    Return the value of the rules property.

    Contents: Code specifying which rules will appear between cells within this table. Valid values are: none (no rules, default value); groups (between row groups); rows (between rows only); cols (between columns only); and all (between all rows and columns).

 public String getStyle() 

    Return the value of the style property.

    Contents: CSS style(s) to be applied when this component is rendered.

 public String getStyleClass() 

    Return the value of the styleClass property.

    Contents: Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.

 public String getSummary() 

    Return the value of the summary property.

    Contents: Summary of this table's purpose and structure, for user agents rendering to non-visual media such as speech and Braille.

 public String getTitle() 

    Return the value of the title property.

    Contents: Advisory title information about markup elements generated for this component.

 public String getWidth() 

    Return the value of the width property.

    Contents: Width of the entire table, for visual user agents.

 public  void setBgcolor(String bgcolor) 

    Set the value of the bgcolor property.

 public  void setBodyrows(String bodyrows) 

    Set the value of the bodyrows property.

 public  void setBorder(int border) 

    Set the value of the border property.

 public  void setCaptionClass(String captionClass) 

    Set the value of the captionClass property.

 public  void setCaptionStyle(String captionStyle) 

    Set the value of the captionStyle property.

 public  void setCellpadding(String cellpadding) 

    Set the value of the cellpadding property.

 public  void setCellspacing(String cellspacing) 

    Set the value of the cellspacing property.

 public  void setColumnClasses(String columnClasses) 

    Set the value of the columnClasses property.

 public  void setDir(String dir) 

    Set the value of the dir property.

 public  void setFooterClass(String footerClass) 

    Set the value of the footerClass property.

 public  void setFrame(String frame) 

    Set the value of the frame property.

 public  void setHeaderClass(String headerClass) 

    Set the value of the headerClass property.

 public  void setLang(String lang) 

    Set the value of the lang property.

 public  void setOnclick(String onclick) 

    Set the value of the onclick property.

 public  void setOndblclick(String ondblclick) 

    Set the value of the ondblclick property.

 public  void setOnkeydown(String onkeydown) 

    Set the value of the onkeydown property.

 public  void setOnkeypress(String onkeypress) 

    Set the value of the onkeypress property.

 public  void setOnkeyup(String onkeyup) 

    Set the value of the onkeyup property.

 public  void setOnmousedown(String onmousedown) 

    Set the value of the onmousedown property.

 public  void setOnmousemove(String onmousemove) 

    Set the value of the onmousemove property.

 public  void setOnmouseout(String onmouseout) 

    Set the value of the onmouseout property.

 public  void setOnmouseover(String onmouseover) 

    Set the value of the onmouseover property.

 public  void setOnmouseup(String onmouseup) 

    Set the value of the onmouseup property.

 public  void setRowClasses(String rowClasses) 

    Set the value of the rowClasses property.

 public  void setRules(String rules) 

    Set the value of the rules property.

 public  void setStyle(String style) 

    Set the value of the style property.

 public  void setStyleClass(String styleClass) 

    Set the value of the styleClass property.

 public  void setSummary(String summary) 

    Set the value of the summary property.

 public  void setTitle(String title) 

    Set the value of the title property.

 public  void setWidth(String width) 

    Set the value of the width property.