FieldHyperlinkRenderer

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 FieldHyperlinkRenderer

java.lang.Object
  com.raritantechnologies.searchApp.taglibrary.BasicResultRenderer
      com.raritantechnologies.quickstart.taglibrary.FieldHyperlinkRenderer

All Implemented Interfaces:: IConfigurable, IPreferencesBeanInfo, IResultRenderer

public class FieldHyperlinkRenderer
extends BasicResultRenderer
implements IResultRenderer

Renders an IResult URL field as a hyperlink.

XML Configuration Template:

   <ResultRenderer 
       rendererClass="com.raritantechnologies.quickstart.taglibrary.FieldHyperlinkRenderer" 
       cssClass="[css class of hyperlink]"
       target="myFrame"
       newWindow="true"	// similar to target="_new" except uses window.open()
       features="third argument to window.open()"
       anchorAttribute="[ href(default)|name ]"
       fixXML="[ true(default)|false  fix Amper Encoding... ]" >

     <HrefField ID="URL" format="[ view.jsp?url={0}&otherField={otherField}&resultNum={_RESULTNUM_} ]"
                   urlEncode="[ single|double ]" requestParams="[ list of request parameters to include ]"/>
     <LabelField ID="Title" />

     <!-- Can also use standard fields for URL and Title: _URL_FIELD_  and _TITLE_FIELD_

     <!-- OR use ResultRenderer for the label: -->
     <LabelRenderer rendererClass="[some result renderer]" >
        <!-- LabelRenderer stuff... -->
     </LabelRenderer>

   </ResultRenderer>

Generates this HTML:

 <a href="[VALUE OF URL field in Result]" target="top" class="bigAndBold">[Value of Title field in Result]</a>

Configuration Schema for label as a static value:

   <ResultRenderer 
       rendererClass="com.raritantechnologies.quickstart.taglibrary.FieldHyperlinkRenderer" 
       target="_new" 
       newWindow="true|false(default)"
       cssClass="smallAndUnobtrusive" >

     <HrefField ID="[ result field ID for hyperlink href ]"
                   [ format=" formatting pattern " ]
                   [ urlEncode="single|double" ]  />

     <LabelField ID="[ result field ID for hyperlink display ]" />

     <!-- Alternatively: specify a fixed display for all hyperlinks -->
     <Label>The Label</Label>

     <!-- Alternatively: specify another ResultRenderer to render link display -->
     <LabelRenderer rendererClass="[some result renderer]" >
          <!-- LabelRenderer stuff... -->
     </LabelRenderer>

   </ResultRenderer>

Generates this HTML:

 <a href="[VALUE OF URL field in Result]" target="_new" class="smallAndUnobtrusive">The Label</a>

Developed by Raritan Technologies Inc..

Author:: Ted Sullivan

Field Summary
`static java.lang.String`	`HREF`
`static java.lang.String`	`LABEL`

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

enabled, name, prefBeanName, prefCompareValue, prefEnableIfInChecklist, prefEnableIfInYesno

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

TEMPLATE

Constructor Summary
`FieldHyperlinkRenderer()`
`FieldHyperlinkRenderer(java.lang.String hrefField, java.lang.String labelField, boolean isField)`

Method Summary
`protected java.lang.String`	`doRenderResult(IResult result, int firstResult, int lastResult, int resultNum, RaritanPageContext pageContext)`
`java.lang.String`	`getConfigurationXML()`
`java.lang.String`	`getConfigurationXML(java.lang.String configurationTemplate)`
`void`	`getConfigurationXML(java.io.Writer writer)`
`java.lang.String`	`getCssClass()`
`java.lang.String`	`getHrefField()`
`java.lang.String`	`getLabelField()`
`java.lang.String`	`getLabelValue()`
`IResultRenderer`	`getLinkRenderer()`
`java.lang.String`	`getTarget()`
`void`	`initialize(org.w3c.dom.Element elem)` IResultRenderers are XML configurable.
`void`	`setCssClass(java.lang.String cssClass)`
`void`	`setHrefField(java.lang.String hrefField)`
`void`	`setLabelField(java.lang.String labelField)`
`void`	`setLabelValue(java.lang.String labelValue)`
`void`	`setLinkRenderer(IResultRenderer linkRenderer)`
`void`	`setTarget(java.lang.String target)`

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

getPrefBeanName, getPrefCompareValue, getPrefEnableIfInChecklist, getPrefEnableIfInYesno, getRenderer, isEnabled, renderResult, setEnable

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.raritantechnologies.searchApp.taglibrary.IResultRenderer

getRenderer, isEnabled, renderResult, setEnable

Field Detail

HREF

public static final java.lang.String HREF

See Also:: Constant Field Values

LABEL

public static final java.lang.String LABEL

See Also:: Constant Field Values

Constructor Detail