com.redhat.rhn.frontend.taglibs

Class ColumnTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

com.redhat.rhn.frontend.taglibs.ColumnTag

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

Direct Known Subclasses:

SetTag

public class ColumnTag
extends javax.servlet.jsp.tagext.TagSupport

The ColumnTag represents a column of data in a ListView. It must be used within a ListDisplayTag. It will setup the title of the column using the header attribute, and display the body after it has setup the header. The column has six main attributes: header, style, cssClass, url, width and renderUrl.

The header is a REQUIRED attribute. All other attributes are optional.

You can specify html formatting with the style, cssClass, nowrap and width attributes.

Example usage of the ColumnTag:

 <rhn:column header="l10n.jsp.message"
                "text-align: center;
                nowrap="true"
                url="someurl?id=${current.id}">
     ${current.name}
 </rhn:column>
 

The renderUrl is a boolean which allows you to turn off the url rendering based on some calculated value. This is useful when you want the column to show a url for all content except a particular condition. Below is an example usage of this boolean and the sample output. Assuming ${current.id} is equal to zero (0) the url will render.

 <rhn:column header="l10n.jsp.message"
                url="http://www.somesite.com"
                renderUrl="${current.id == 0}" >
     sometext
 </rhn:column>
 

Sample output:

 ...
 <a href="http://www.somesite.com">sometext</a>
 ...
 

Otherwise, you simply get sometext.

See Also:

ListTag, ListDisplayTag, SetTag, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DYNAMIC_HEADER

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor and Description
ColumnTag() Default constructor
ColumnTag(ColumnTag c) Copy constructor.

Method Summary

Modifier and Type	Method and Description
int	doEndTag()
int	doStartTag()
boolean	equals(java.lang.Object obj)
ListDisplayTag	findListDisplay() Returns the ListDisplayTag that serves as the parent tag.
UnpagedListDisplayTag	findUnpagedListDisplay() Returns the ListDisplayTag that serves as the parent tag.
java.lang.String	getArg0()
java.lang.String	getColspan()
java.lang.String	getCssClass() Returns the CSS class attribute.
java.lang.String	getHeader() Returns the header column name.
java.lang.String	getHeaderStyle()
java.lang.String	getNowrap()
java.lang.String	getSortProperty()
java.lang.String	getStyle()
java.lang.String	getUrl() Returns the url.
java.lang.String	getWidth() Returns the column width.
int	hashCode()
boolean	isRenderUrl() Returns flag indicating whether the URL should be rendered.
boolean	isUsesRefactoredList()
void	release()
protected void	renderData(javax.servlet.jsp.JspWriter out, ListDisplayTag parent) Displays the opening of the TD tag and prepares it for displaying the body contents.
protected void	renderData(javax.servlet.jsp.JspWriter out, UnpagedListDisplayTag parent) Displays the opening of the TD tag and prepares it for displaying the body contents.
protected java.lang.String	renderHeaderData(java.lang.String hdr, java.lang.String arg)
void	setArg0(java.lang.String arg0In)
void	setColspan(java.lang.String colspanIn)
void	setCssClass(java.lang.String css) Sets the CSS class attribute.
void	setHeader(java.lang.String hdr) Sets the header column name.
void	setHeaderStyle(java.lang.String headerStyleIn)
void	setNowrap(java.lang.String noWrapIn)
void	setRenderUrl(boolean render) The flag indicating whether the URL should be rendered.
void	setSortProperty(java.lang.String sortPropertyIn)
void	setStyle(java.lang.String styleIn) Sets the style
void	setUrl(java.lang.String urlIn) The URL to render around the body.
void	setUsesRefactoredList(boolean usesRefactoredListIn)
void	setWidth(java.lang.String w) Sets the column width in terms of pixels or percentage.

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

DYNAMIC_HEADER

public static final java.lang.String DYNAMIC_HEADER

See Also:

Constant Field Values

Constructor Detail

ColumnTag

public ColumnTag()

Default constructor

ColumnTag

public ColumnTag(ColumnTag c)

Copy constructor.

Parameters:

c - ColumnTag to copy.

Method Detail

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException

renderData

protected void renderData(javax.servlet.jsp.JspWriter out,
                          ListDisplayTag parent)
                   throws java.io.IOException

Displays the opening of the TD tag and prepares it for displaying the body contents.

Parameters:

out - JspWriter to write to.

parent - Containing JspTag.

Throws:

java.io.IOException - if an error occurs writing to the JspWriter.

renderData

protected void renderData(javax.servlet.jsp.JspWriter out,
                          UnpagedListDisplayTag parent)
                   throws java.io.IOException

Displays the opening of the TD tag and prepares it for displaying the body contents.

Parameters:

out - JspWriter to write to.

parent - Containing JspTag.

Throws:

java.io.IOException - if an error occurs writing to the JspWriter.

renderHeaderData

protected java.lang.String renderHeaderData(java.lang.String hdr,
                                            java.lang.String arg)

getStyle

public java.lang.String getStyle()

Returns:

Returns the style

setStyle

public void setStyle(java.lang.String styleIn)

Sets the style

Parameters:

styleIn - Style to set

getHeader

public java.lang.String getHeader()

Returns the header column name.

Returns:

Returns the header.

setHeader

public void setHeader(java.lang.String hdr)

Sets the header column name. Should be a localization key. Optionally, you can pass in a value of "dynamic" in conjunction with the arg0 attribute which will allow you to set a dynamic header.

Parameters:

hdr - The header to set.

getUrl

public java.lang.String getUrl()

Returns the url.

Returns:

Returns the url.

setUrl

public void setUrl(java.lang.String urlIn)

The URL to render around the body. The following example,

    <rhn:column header="foo" url="http://www.hostname.com">
      Data to show.
    </rhn:column>
 

would result in the following HTML being generated:

   
   <td>
     <a href="http://www.hostname.com">Data to show.</a>
   </td>
   
 

Parameters:

urlIn - The url to set.

getNowrap

public java.lang.String getNowrap()

Returns:

Returns the nowrap.

setNowrap

public void setNowrap(java.lang.String noWrapIn)

Parameters:

noWrapIn - The nowrap to set.

setCssClass

public void setCssClass(java.lang.String css)

Sets the CSS class attribute.

Parameters:

css - CSS class attribute.

getCssClass

public java.lang.String getCssClass()

Returns the CSS class attribute.

Returns:

the CSS class attribute.

getWidth

public java.lang.String getWidth()

Returns the column width.

Returns:

the column width.

setWidth

public void setWidth(java.lang.String w)

Sets the column width in terms of pixels or percentage.

Parameters:

w - The column width.

isRenderUrl

public boolean isRenderUrl()

Returns flag indicating whether the URL should be rendered.

Returns:

flag indicating whether the URL should be rendered.

setRenderUrl

public void setRenderUrl(boolean render)

The flag indicating whether the URL should be rendered.

Parameters:

render - flag indicating whether the URL should be rendered.

getArg0

public java.lang.String getArg0()

Returns:

Returns the arg0.

setArg0

public void setArg0(java.lang.String arg0In)

Parameters:

arg0In - The arg0 to set.

getSortProperty

public java.lang.String getSortProperty()

Returns:

Returns the sortProperty.

setSortProperty

public void setSortProperty(java.lang.String sortPropertyIn)

Parameters:

sortPropertyIn - The sortProperty to set.

isUsesRefactoredList

public boolean isUsesRefactoredList()

Returns:

Returns the usesRefactoredList.

setUsesRefactoredList

public void setUsesRefactoredList(boolean usesRefactoredListIn)

Parameters:

usesRefactoredListIn - The usesRefactoredList to set.

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException

findUnpagedListDisplay

public UnpagedListDisplayTag findUnpagedListDisplay()

Returns the ListDisplayTag that serves as the parent tag. Returns null if no ListDisplayTag is found.

Returns:

the parent ListDisplayTag

findListDisplay

public ListDisplayTag findListDisplay()

Returns the ListDisplayTag that serves as the parent tag. Returns null if no ListDisplayTag is found.

Returns:

the parent ListDisplayTag

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

release

public void release()

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

Overrides:

release in class javax.servlet.jsp.tagext.TagSupport

getHeaderStyle

public java.lang.String getHeaderStyle()

Returns:

Returns the headerStyle.

setHeaderStyle

public void setHeaderStyle(java.lang.String headerStyleIn)

Parameters:

headerStyleIn - The headerStyle to set.

getColspan

public java.lang.String getColspan()

Returns:

Returns the colspan.

setColspan

public void setColspan(java.lang.String colspanIn)

Parameters:

colspanIn - The colspan to set.