SortHeaderRenderer

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.raritantechnologies.quickstart.taglibrary
Class SortHeaderRenderer

java.lang.Object
  com.raritantechnologies.searchApp.taglibrary.BasicDisplayFormRenderer
      com.raritantechnologies.quickstart.taglibrary.SortHeaderRenderer

All Implemented Interfaces:: IConfigurable, IDisplayFormRenderer

public class SortHeaderRenderer
extends BasicDisplayFormRenderer

A sortable header that has html properties and configurable icons for displaying sort order. Used with GridDisplayFormRenderer.

It has 3 different ways to display the sort order:

none: no icon showing sort order

single: shows only the active sort direction. Requires 2 icons, ascending and descending order

both: shows the active and inactive sort directions. Requires 4 icons, ascenting and descending in active and inactive state.

It also has has a flag for active/inactive to show that this column is the on currently being sorted.

XML Configuration Template:


  <Column sortable="true" >

  <HeaderRenderer 
      rendererClass="com.raritantechnologies.quickstart.taglibrary.SortHeaderRenderer" 
      displayName="Date" 
      name="LastModDate" 
      align="center" 
      valign="top"
      displayType="none/single/double" 
      activeClass="activeSort" 
      inactiveClass="inactiveSort"
      ascActiveIcon="../images/asc.gif" 
      dscActiveIcon="../images/dsc.gif" 
      ascInactiveIcon="../images/asc_d.gif" 
      dscInactiveIcon="../images/dsc_d.gif"
      bgcolor="#abcdef"
      leftImage="../images/someImage.gif"
      linkText="true" />

Developed by Raritan Technologies Inc..

Author:: Alan Connell

Field Summary

Fields inherited from class com.raritantechnologies.searchApp.taglibrary.BasicDisplayFormRenderer

trailerBuffer

Fields inherited from interface com.raritantechnologies.searchApp.taglibrary.IDisplayFormRenderer

TEMPLATE

Constructor Summary
`SortHeaderRenderer()`

Method Summary
`java.lang.String`	`getAction()`
`java.lang.String`	`getActiveClass()`
`java.lang.String`	`getAlign()`
`java.lang.String`	`getAscActiveIcon()`
`java.lang.String`	`getAscInactiveIcon()`
`java.lang.String`	`getBgColor()`
`java.lang.String`	`getBody(IResultSet resultSet, java.lang.String displayFormName, RaritanPageContext pageContext)` returns the HTML fragment for the given set of results.
`java.lang.String`	`getConfigurationXML()`
`void`	`getConfigurationXML(java.io.Writer writer)`
`java.lang.String`	`getDefSortDir()`
`java.lang.String`	`getDefSortField()`
`java.lang.String`	`getDisplayName()`
`java.lang.String`	`getDisplayType()`
`java.lang.String`	`getDscActiveIcon()`
`java.lang.String`	`getDscInactiveIcon()`
`java.lang.String`	`getInactiveClass()`
`boolean`	`getIsParametric()`
`java.lang.String`	`getLeftImage()`
`boolean`	`getLinkText()`
`java.lang.String`	`getName()`
`boolean`	`getResetPage()`
`java.lang.String`	`getSortable()`
`java.lang.String`	`getTarget()`
`java.lang.String`	`getVAlign()`
`java.lang.String`	`getWidth()`
`void`	`initialize(org.w3c.dom.Element elem)` Initialize the display form renderer from the configuration XML.
`void`	`setAction(java.lang.String action)`
`void`	`setActiveClass(java.lang.String activeClass)`
`void`	`setAlign(java.lang.String align)`
`void`	`setAscActiveIcon(java.lang.String ascActiveIcon)`
`void`	`setAscInactiveIcon(java.lang.String ascInactiveIcon)`
`void`	`setBgColor(java.lang.String bgcolor)`
`void`	`setDefSortDir(java.lang.String defSortDir)`
`void`	`setDefSortField(java.lang.String defSortField)`
`void`	`setDisplayName(java.lang.String displayName)`
`void`	`setDisplayType(java.lang.String displayType)`
`void`	`setDscActiveIcon(java.lang.String dscActiveIcon)`
`void`	`setDscInactiveIcon(java.lang.String dscInactiveIcon)`
`void`	`setInactiveClass(java.lang.String inactiveClass)`
`void`	`setIsParametric(boolean isParametric)`
`void`	`setLeftImage(java.lang.String leftImage)`
`void`	`setLinkText(boolean linkText)`
`void`	`setName(java.lang.String name)`
`void`	`setResetPage(boolean resetPage)`
`void`	`setSortable(java.lang.String sortable)`
`void`	`setTarget(java.lang.String target)`
`void`	`setVAlign(java.lang.String vAlign)`
`void`	`setWidth(java.lang.String width)`

Methods inherited from class com.raritantechnologies.searchApp.taglibrary.BasicDisplayFormRenderer

addBodyTrailerContent, disableRenderers, enableRenderers, getResultRenderer, initialize, setBackgroundColor1, setBackgroundColor2, setColumnSpacing, setDisabledRendererParam, setEnabledRendererParam, setEnabledRenderers, setFieldNameCSSClass, setFielValueCSSClass, setHeaderWidth, setResultWidth

Methods inherited from class java.lang.Object

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

Constructor Detail