|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.render.Renderer
org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlRenderer
org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlTableRendererBase
org.apache.myfaces.renderkit.html.ext.HtmlTableRenderer
@JSFRenderer(renderKitId="HTML_BASIC", family="javax.faces.Data", type="org.apache.myfaces.Table") public class HtmlTableRenderer
Renderer for the Tomahawk extended HtmlDataTable component.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlTableRendererBase |
---|
HtmlTableRendererBase.Styles |
Field Summary | |
---|---|
static String |
DETAIL_STAMP_FACET_NAME
DetailStamp facet name. |
static String |
ROW_CLICK
|
static String |
ROW_DBLCLICK
|
static String |
ROW_KEYDOWN
|
static String |
ROW_KEYPRESS
|
static String |
ROW_KEYUP
|
static String |
ROW_MOUSEDOWN
|
static String |
ROW_MOUSEMOVE
|
static String |
ROW_MOUSEOUT
|
static String |
ROW_MOUSEOVER
|
static String |
ROW_MOUSEUP
|
static String |
ROW_ONCLICK_ATTR
|
static String |
ROW_ONDBLCLICK_ATTR
|
static String |
ROW_ONKEYDOWN_ATTR
|
static String |
ROW_ONKEYPRESS_ATTR
|
static String |
ROW_ONKEYUP_ATTR
|
static String |
ROW_ONMOUSEDOWN_ATTR
|
static String |
ROW_ONMOUSEMOVE_ATTR
|
static String |
ROW_ONMOUSEOUT_ATTR
|
static String |
ROW_ONMOUSEOVER_ATTR
|
static String |
ROW_ONMOUSEUP_ATTR
|
Fields inherited from class org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlTableRendererBase |
---|
CAPTION_FACET_NAME, FOOTER_FACET_NAME, HEADER_FACET_NAME |
Constructor Summary | |
---|---|
HtmlTableRenderer()
|
Method Summary | |
---|---|
protected void |
afterRow(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIData uiData)
Perform any operations necessary immediately after each TR end tag is output. |
protected boolean |
amISpannedOver(String prefix,
javax.faces.component.UIComponent component)
specify if the header, footer or is spanned over (not shown) because of a colspan in a cell in a previous column |
protected void |
beforeBody(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIData uiData)
Perform any operations necessary after TABLE start tag is output but before the TBODY start tag. |
protected void |
beforeColumn(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIData uiData,
int columnIndex)
Perform any operations necessary immediately before each column child is rendered |
protected void |
beforeColumnHeaderOrFooter(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIData uiData,
boolean header,
int columnIndex)
Perform any operations necessary immediately before each column child's header or footer is rendered |
protected void |
beforeRow(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIData uiData)
Perform any operations necessary immediately before each TR start tag is output. |
protected void |
collectChildrenValues(List container,
Iterator iterChildren)
|
protected int |
determineChildColSpan(javax.faces.component.UIComponent uiComponent)
Return the number of columns spanned by the specified component. |
protected String |
determineHeaderCellTag(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent component)
|
protected String |
determineHeaderFooterTag(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent component,
boolean header)
|
protected boolean |
determineRenderFacet(javax.faces.component.UIComponent component,
boolean header)
determine if the header or footer should be rendered. |
void |
encodeBegin(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent uiComponent)
Render the necessary bits that come before any actual rows in the table. |
void |
encodeChildren(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent component)
Render the TBODY section of the html table. |
protected void |
encodeColumnChild(javax.faces.context.FacesContext facesContext,
javax.faces.context.ResponseWriter writer,
javax.faces.component.UIData uiData,
javax.faces.component.UIComponent component,
HtmlTableRendererBase.Styles styles,
int columnStyleIndex)
Render the specified column object using the current row data. |
void |
encodeEnd(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent uiComponent)
|
protected void |
endTable(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent uiComponent)
actually render the end of the table |
protected int |
getNewspaperColumns(javax.faces.component.UIComponent component)
|
protected javax.faces.component.UIComponent |
getNewspaperTableSpacer(javax.faces.component.UIComponent component)
|
protected boolean |
hasFacet(boolean header,
javax.faces.component.UIComponent uiComponent)
Return true if the specified component has a facet that needs to be rendered in a THEAD or TFOOT section. |
protected boolean |
hasNewspaperTableSpacer(javax.faces.component.UIComponent component)
|
protected void |
inBodyStart(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIData uiData)
Perform any operations necessary in the TBODY start tag. |
protected boolean |
isCommonEventsOptimizationEnabled(javax.faces.context.FacesContext facesContext)
|
protected boolean |
isCommonPropertiesOptimizationEnabled(javax.faces.context.FacesContext facesContext)
|
protected boolean |
isDetailStampAfterRow(javax.faces.component.UIComponent uiComponent)
|
protected boolean |
isEmbeddedTable(javax.faces.component.UIComponent uiComponent)
|
protected boolean |
isListEqual(List list1,
List list2)
checks if the contenta of both lists are the same. Notice: In case both lists are null or empty they are considered NOT being equal |
protected boolean |
isNewspaperHorizontalOrientation(javax.faces.component.UIComponent component)
|
protected void |
putSortedReqScopeParam(javax.faces.context.FacesContext facesContext,
HtmlDataTable dataTable,
int columnIndex)
|
protected void |
renderColumnBody(javax.faces.context.FacesContext facesContext,
javax.faces.context.ResponseWriter writer,
javax.faces.component.UIData uiData,
javax.faces.component.UIComponent component,
HtmlTableRendererBase.Styles styles,
int columnStyleIndex)
Renders the body of a given UIColumn (everything but
the header and footer facets). |
protected void |
renderColumnChildHeaderOrFooterRow(javax.faces.context.FacesContext facesContext,
javax.faces.context.ResponseWriter writer,
javax.faces.component.UIComponent uiComponent,
String styleClass,
boolean header)
Render the header or footer of the specified column object. |
protected void |
renderColumnFooterCell(javax.faces.context.FacesContext facesContext,
javax.faces.context.ResponseWriter writer,
javax.faces.component.UIComponent uiComponent,
javax.faces.component.UIComponent facet,
String footerStyleClass,
int colspan)
Renders the footer facet for the given UIColumn . |
protected void |
renderColumnFooterRow(javax.faces.context.FacesContext facesContext,
javax.faces.context.ResponseWriter writer,
javax.faces.component.UIComponent component,
String footerStyleClass)
Renders the column footer. |
protected void |
renderColumnHeaderCell(javax.faces.context.FacesContext facesContext,
javax.faces.context.ResponseWriter writer,
javax.faces.component.UIComponent uiComponent,
javax.faces.component.UIComponent facet,
String headerStyleClass,
int colspan)
Renders a TH cell within a TR within a THEAD section. |
protected void |
renderColumnHeaderRow(javax.faces.context.FacesContext facesContext,
javax.faces.context.ResponseWriter writer,
javax.faces.component.UIComponent component,
String headerStyleClass)
Renders the column header. |
protected void |
renderHtmlColumnAttributes(javax.faces.context.FacesContext facesContext,
javax.faces.context.ResponseWriter writer,
javax.faces.component.UIComponent uiComponent,
String prefix)
|
protected void |
renderRowAttribute(javax.faces.context.ResponseWriter writer,
String htmlAttribute,
Object value)
|
protected void |
renderRowStart(javax.faces.context.FacesContext facesContext,
javax.faces.context.ResponseWriter writer,
javax.faces.component.UIData uiData,
HtmlTableRendererBase.Styles styles,
int rowStyleIndex)
Renders the start of a new row of body content. |
protected void |
renderRowStyle(javax.faces.context.FacesContext facesContext,
javax.faces.context.ResponseWriter writer,
javax.faces.component.UIData uiData,
HtmlTableRendererBase.Styles styles,
int rowStyleIndex)
|
protected void |
renderTableHeaderOrFooterRow(javax.faces.context.FacesContext facesContext,
javax.faces.context.ResponseWriter writer,
javax.faces.component.UIComponent component,
javax.faces.component.UIComponent facet,
String styleClass,
String colElementName,
int colspan,
boolean isHeader)
|
protected void |
startTable(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent uiComponent)
actually render the start of the table |
Methods inherited from class org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlTableRendererBase |
---|
afterBody, afterColumn, afterColumnHeaderOrFooter, afterTable, beforeTable, decode, encodeInnerHtml, getFooterClass, getHeaderClass, getRendersChildren, getStyles, renderCaptionFacet, renderColgroupsFacet, renderColumnFooterCell, renderColumnHeaderCell, renderFacet, renderRowEnd, renderSpacerCell, renderTableFooterRow, renderTableHeaderRow |
Methods inherited from class org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlRenderer |
---|
getActionUrl, getChildCount, getChildren, getClientId, renderId, shouldRenderId, toUri |
Methods inherited from class javax.faces.render.Renderer |
---|
convertClientId, getConvertedValue |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String DETAIL_STAMP_FACET_NAME
public static final String ROW_CLICK
public static final String ROW_DBLCLICK
public static final String ROW_KEYDOWN
public static final String ROW_KEYPRESS
public static final String ROW_KEYUP
public static final String ROW_MOUSEDOWN
public static final String ROW_MOUSEMOVE
public static final String ROW_MOUSEOUT
public static final String ROW_MOUSEOVER
public static final String ROW_MOUSEUP
public static final String ROW_ONCLICK_ATTR
public static final String ROW_ONDBLCLICK_ATTR
public static final String ROW_ONKEYDOWN_ATTR
public static final String ROW_ONKEYPRESS_ATTR
public static final String ROW_ONKEYUP_ATTR
public static final String ROW_ONMOUSEDOWN_ATTR
public static final String ROW_ONMOUSEMOVE_ATTR
public static final String ROW_ONMOUSEOUT_ATTR
public static final String ROW_ONMOUSEOVER_ATTR
public static final String ROW_ONMOUSEUP_ATTR
Constructor Detail |
---|
public HtmlTableRenderer()
Method Detail |
---|
protected boolean isCommonPropertiesOptimizationEnabled(javax.faces.context.FacesContext facesContext)
isCommonPropertiesOptimizationEnabled
in class HtmlRenderer
protected boolean isCommonEventsOptimizationEnabled(javax.faces.context.FacesContext facesContext)
isCommonEventsOptimizationEnabled
in class HtmlRenderer
protected int getNewspaperColumns(javax.faces.component.UIComponent component)
getNewspaperColumns
in class HtmlTableRendererBase
component
- dataTable
protected javax.faces.component.UIComponent getNewspaperTableSpacer(javax.faces.component.UIComponent component)
getNewspaperTableSpacer
in class HtmlTableRendererBase
component
- dataTable
protected boolean hasNewspaperTableSpacer(javax.faces.component.UIComponent component)
hasNewspaperTableSpacer
in class HtmlTableRendererBase
component
- dataTable
protected boolean isNewspaperHorizontalOrientation(javax.faces.component.UIComponent component)
isNewspaperHorizontalOrientation
in class HtmlTableRendererBase
component
- dataTable
protected void startTable(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent) throws IOException
HtmlTableRendererBase
startTable
in class HtmlTableRendererBase
IOException
protected String determineHeaderFooterTag(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component, boolean header)
determineHeaderFooterTag
in class HtmlTableRendererBase
protected String determineHeaderCellTag(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component)
determineHeaderCellTag
in class HtmlTableRendererBase
protected void renderTableHeaderOrFooterRow(javax.faces.context.FacesContext facesContext, javax.faces.context.ResponseWriter writer, javax.faces.component.UIComponent component, javax.faces.component.UIComponent facet, String styleClass, String colElementName, int colspan, boolean isHeader) throws IOException
renderTableHeaderOrFooterRow
in class HtmlTableRendererBase
IOException
protected boolean isEmbeddedTable(javax.faces.component.UIComponent uiComponent)
protected boolean isDetailStampAfterRow(javax.faces.component.UIComponent uiComponent)
protected void endTable(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent) throws IOException
HtmlTableRendererBase
endTable
in class HtmlTableRendererBase
IOException
protected void beforeRow(javax.faces.context.FacesContext facesContext, javax.faces.component.UIData uiData) throws IOException
HtmlTableRendererBase
beforeRow
in class HtmlTableRendererBase
facesContext
- the FacesContext
.uiData
- the UIData
being rendered.
IOException
protected void afterRow(javax.faces.context.FacesContext facesContext, javax.faces.component.UIData uiData) throws IOException
HtmlTableRendererBase
afterRow
in class HtmlTableRendererBase
facesContext
- the FacesContext
.uiData
- the UIData
being rendered.
IOException
public void encodeBegin(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent) throws IOException
HtmlTableRendererBase
encodeBegin
in class HtmlTableRendererBase
IOException
HtmlTableRendererBase.encodeBegin(javax.faces.context.FacesContext, javax.faces.component.UIComponent)
public void encodeChildren(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component) throws IOException
HtmlTableRendererBase
encodeChildren
in class HtmlTableRendererBase
IOException
HtmlTableRendererBase.encodeChildren(javax.faces.context.FacesContext, javax.faces.component.UIComponent)
protected void beforeBody(javax.faces.context.FacesContext facesContext, javax.faces.component.UIData uiData) throws IOException
HtmlTableRendererBase
This method generates the THEAD/TFOOT sections of a table if there are any header or footer facets defined on the table or on any child UIColumn component.
beforeBody
in class HtmlTableRendererBase
facesContext
- the FacesContext
.uiData
- the UIData
being rendered.
IOException
protected void collectChildrenValues(List container, Iterator iterChildren)
protected boolean isListEqual(List list1, List list2)
public void encodeEnd(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent) throws IOException
encodeEnd
in class HtmlTableRendererBase
IOException
HtmlTableRendererBase.encodeEnd(javax.faces.context.FacesContext, javax.faces.component.UIComponent)
protected void renderRowStart(javax.faces.context.FacesContext facesContext, javax.faces.context.ResponseWriter writer, javax.faces.component.UIData uiData, HtmlTableRendererBase.Styles styles, int rowStyleIndex) throws IOException
HtmlTableRendererBase
renderRowStart
in class HtmlTableRendererBase
facesContext
- the FacesContext
.writer
- the ResponseWriter
.uiData
- the UIData
being rendered.
IOException
- if an exceptoin occurs.protected void renderRowStyle(javax.faces.context.FacesContext facesContext, javax.faces.context.ResponseWriter writer, javax.faces.component.UIData uiData, HtmlTableRendererBase.Styles styles, int rowStyleIndex) throws IOException
renderRowStyle
in class HtmlTableRendererBase
IOException
HtmlTableRendererBase.renderRowStyle(javax.faces.context.FacesContext, javax.faces.context.ResponseWriter, javax.faces.component.UIData, org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlTableRendererBase.Styles, int)
protected void renderRowAttribute(javax.faces.context.ResponseWriter writer, String htmlAttribute, Object value) throws IOException
IOException
protected void encodeColumnChild(javax.faces.context.FacesContext facesContext, javax.faces.context.ResponseWriter writer, javax.faces.component.UIData uiData, javax.faces.component.UIComponent component, HtmlTableRendererBase.Styles styles, int columnStyleIndex) throws IOException
For each dynamic column in that UIColumns child: * Select the column (which sets variable named by the var attribute to refer to the current column object) * Call this.renderColumnBody passing the UIColumns object.The renderColumnBody method eventually:
encodeColumnChild
in class HtmlTableRendererBase
IOException
HtmlTableRendererBase.encodeColumnChild(javax.faces.context.FacesContext, javax.faces.context.ResponseWriter, javax.faces.component.UIData, javax.faces.component.UIComponent, org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlTableRendererBase.Styles, int)
protected void renderColumnBody(javax.faces.context.FacesContext facesContext, javax.faces.context.ResponseWriter writer, javax.faces.component.UIData uiData, javax.faces.component.UIComponent component, HtmlTableRendererBase.Styles styles, int columnStyleIndex) throws IOException
HtmlTableRendererBase
UIColumn
(everything but
the header and footer facets). This emits a TD cell, whose contents
are the result of calling encodeBegin, encodeChildren and
encodeEnd methods on the component (or its associated renderer).
renderColumnBody
in class HtmlTableRendererBase
facesContext
- the FacesContext
.writer
- the ResponseWriter
.uiData
- the UIData
being rendered.component
- the UIComponent
to render.
IOException
- if an exception occurs.HtmlTableRendererBase.renderColumnBody(javax.faces.context.FacesContext, javax.faces.context.ResponseWriter, javax.faces.component.UIData, javax.faces.component.UIComponent, org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlTableRendererBase.Styles, int)
protected void renderColumnChildHeaderOrFooterRow(javax.faces.context.FacesContext facesContext, javax.faces.context.ResponseWriter writer, javax.faces.component.UIComponent uiComponent, String styleClass, boolean header) throws IOException
For each dynamic column in that UIColumns child: * Select the column (which sets variable named by the var attribute to refer to the current column object) * Call this.renderColumnHeaderCell or this.renderColumnFooterCell passing the header or footer facet of the UIColumns object.If the facet of the UIColumns accesses the variable named by the var attribute on the UIColumns object, then it ends up rendering content that is extracted from the current column object.
renderColumnChildHeaderOrFooterRow
in class HtmlTableRendererBase
IOException
HtmlTableRendererBase.renderColumnChildHeaderOrFooterRow(javax.faces.context.FacesContext, javax.faces.context.ResponseWriter, javax.faces.component.UIComponent, java.lang.String, boolean)
protected void renderColumnHeaderCell(javax.faces.context.FacesContext facesContext, javax.faces.context.ResponseWriter writer, javax.faces.component.UIComponent uiComponent, javax.faces.component.UIComponent facet, String headerStyleClass, int colspan) throws IOException
HtmlTableRendererBase
renderColumnHeaderCell
in class HtmlTableRendererBase
facesContext
- the FacesContext
.writer
- the ResponseWriter
.uiComponent
- the UIComponent
to render the facet for.facet
- the UIComponent
to render as facet.headerStyleClass
- the styleClass of the header facet.colspan
- the colspan for the tableData element in which the header facet
will be wrapped.
IOException
HtmlTableRendererBase.renderColumnHeaderCell(javax.faces.context.FacesContext, javax.faces.context.ResponseWriter, javax.faces.component.UIComponent, javax.faces.component.UIComponent, java.lang.String, int)
protected void renderColumnFooterCell(javax.faces.context.FacesContext facesContext, javax.faces.context.ResponseWriter writer, javax.faces.component.UIComponent uiComponent, javax.faces.component.UIComponent facet, String footerStyleClass, int colspan) throws IOException
HtmlTableRendererBase
UIColumn
.
renderColumnFooterCell
in class HtmlTableRendererBase
facesContext
- the FacesContext
.writer
- the ResponseWriter
.uiComponent
- the UIComponent
to render the facet for.facet
- the UIComponent
to render as facet.footerStyleClass
- the styleClass of the footer facet.colspan
- the colspan for the tableData element in which the footer facet
will be wrapped.
IOException
HtmlTableRendererBase.renderColumnFooterCell(javax.faces.context.FacesContext, javax.faces.context.ResponseWriter, javax.faces.component.UIComponent, javax.faces.component.UIComponent, java.lang.String, int)
protected void renderHtmlColumnAttributes(javax.faces.context.FacesContext facesContext, javax.faces.context.ResponseWriter writer, javax.faces.component.UIComponent uiComponent, String prefix) throws IOException
IOException
protected int determineChildColSpan(javax.faces.component.UIComponent uiComponent)
determineChildColSpan
in class HtmlTableRendererBase
#determineChildColSpan(javax.faces.component.UIComponent)
protected boolean hasFacet(boolean header, javax.faces.component.UIComponent uiComponent)
hasFacet
in class HtmlTableRendererBase
HtmlTableRendererBase.hasFacet(boolean, javax.faces.component.UIComponent)
protected void renderColumnFooterRow(javax.faces.context.FacesContext facesContext, javax.faces.context.ResponseWriter writer, javax.faces.component.UIComponent component, String footerStyleClass) throws IOException
renderColumnFooterRow
in class HtmlTableRendererBase
facesContext
- the FacesContext
.writer
- the ResponseWriter
.component
- the UIComponent
for whom a table is being rendered.footerStyleClass
- the styleClass of the footerStyleClass
IOException
- if an exception occurs.protected void renderColumnHeaderRow(javax.faces.context.FacesContext facesContext, javax.faces.context.ResponseWriter writer, javax.faces.component.UIComponent component, String headerStyleClass) throws IOException
renderColumnHeaderRow
in class HtmlTableRendererBase
facesContext
- the FacesContext
.writer
- the ResponseWriter
.component
- the UIData component for whom a table is being rendered.headerStyleClass
- the styleClass of the header
IOException
- if an exception occurs.protected boolean determineRenderFacet(javax.faces.component.UIComponent component, boolean header)
protected void beforeColumn(javax.faces.context.FacesContext facesContext, javax.faces.component.UIData uiData, int columnIndex) throws IOException
HtmlTableRendererBase
beforeColumn
in class HtmlTableRendererBase
facesContext
- the FacesContext
.uiData
- the UIData
being rendered.columnIndex
- the index of the currenly rendered column
IOException
protected void beforeColumnHeaderOrFooter(javax.faces.context.FacesContext facesContext, javax.faces.component.UIData uiData, boolean header, int columnIndex) throws IOException
HtmlTableRendererBase
beforeColumnHeaderOrFooter
in class HtmlTableRendererBase
facesContext
- the FacesContext
.uiData
- the UIData
being rendered.header
- true if the header of the column child is renderedcolumnIndex
- the index of the currenly rendered column
IOException
protected void putSortedReqScopeParam(javax.faces.context.FacesContext facesContext, HtmlDataTable dataTable, int columnIndex)
protected boolean amISpannedOver(String prefix, javax.faces.component.UIComponent component)
prefix
- header, footer or nullcomponent
- protected void inBodyStart(javax.faces.context.FacesContext facesContext, javax.faces.component.UIData uiData) throws IOException
inBodyStart
in class HtmlTableRendererBase
facesContext
- the FacesContext
.uiData
- the UIData
being rendered.
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |