HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.transform.elements
Class URLComponentElement

java.lang.Object
  extended by com.ibm.hats.transform.elements.ComponentElement
      extended by com.ibm.hats.transform.elements.URLComponentElement
All Implemented Interfaces:
Cloneable

public class URLComponentElement
extends ComponentElement

This class represents a URL.


Field Summary
static String CLASS_NAME
           
 
Fields inherited from class com.ibm.hats.transform.elements.ComponentElement
consumedRegion
 
Constructor Summary
URLComponentElement(String url, String caption)
          Constructs a new URLComponentElement object.
 
Method Summary
 void doTextReplacement(TextReplacementPair pair, ContextAttributes contextAttributes)
          Performs text replacement on the caption of this element.
 String getCaption()
          Returns the caption of this URL.
 String getPreviewText()
          Returns some form of descriptive text about the component element.
 String getUrl()
          Returns the full URL.
 void setCaption(String string)
          Sets the caption of this element.
 void setUrl(String string)
          Sets the URL.
 
Methods inherited from class com.ibm.hats.transform.elements.ComponentElement
clone, getConsumedRegion, getScreenId, isConsumer, isMatch, isTruncateToPreserveLength, setConsumedRegion, setScreenId, type, type
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASS_NAME

public static final String CLASS_NAME
See Also:
Constant Field Values
Constructor Detail

URLComponentElement

public URLComponentElement(String url,
                           String caption)
Constructs a new URLComponentElement object.

Parameters:
url - URL
caption - caption of the URL (normally the URL itself)
Method Detail

getPreviewText

public String getPreviewText()
Description copied from class: ComponentElement
Returns some form of descriptive text about the component element.

Specified by:
getPreviewText in class ComponentElement

doTextReplacement

public void doTextReplacement(TextReplacementPair pair,
                              ContextAttributes contextAttributes)
Performs text replacement on the caption of this element.

Specified by:
doTextReplacement in class ComponentElement
Parameters:
pair - TextReplacementPair to base replacement on
contextAttributes - context attributes

getCaption

public String getCaption()
Returns the caption of this URL.

Returns:
The caption of this URL.

getUrl

public String getUrl()
Returns the full URL.

Returns:
The full URL.

setCaption

public void setCaption(String string)
Sets the caption of this element.

Parameters:
string -

setUrl

public void setUrl(String string)
Sets the URL.

Parameters:
string -

HATS 7.5.1 (201005110649)