com.filenet.wcm.toolkit.server.util.ui
Class WcmImageAnchor

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.util.ui.WcmAnchor
      extended bycom.filenet.wcm.toolkit.server.util.ui.WcmImageAnchor

Deprecated. This class extends the base WcmAnchor classs and implements an image anchor that can have two states (selected and unselected). The current state is indicated by the active image.

public class WcmImageAnchor
extends WcmAnchor


Field Summary
protected  java.lang.String altSelectedImageLabel
          Deprecated. The label of the HTML image alt attribute for the selected image.
protected  java.lang.String altUnSelectedImageLabel
          Deprecated. The label of the HTML image alt attribute for the unselected image.
protected  java.lang.String imageAttributes
          Deprecated. Any additional image HTML attributes.
static WcmString LOCALIZED_IMAGE_PATH
          Deprecated. The localized image path.
protected  boolean selected
          Deprecated.  
protected  java.lang.String selectedImageUrl
          Deprecated. The url path of the selected image.
protected  java.lang.String unSelectedImageUrl
          Deprecated. The url path of the unselected image.
 
Fields inherited from class com.filenet.wcm.toolkit.server.util.ui.WcmAnchor
disabled, extraAttributes, hidden, id, label, locLabel, onClick, onContextMenu, popup, toolTip, urlObject, urlString, windowHeight, windowWidth
 
Constructor Summary
WcmImageAnchor(java.lang.String url, java.lang.String label, java.lang.String selectedImageURL, java.lang.String unSelectedImageURL)
          Deprecated. Contructs a new WcmImageAnchor object.
WcmImageAnchor(java.lang.String url, WcmString localizedLabel, java.lang.String selectedImageURL, java.lang.String unSelectedImageURL)
          Deprecated. Contructs a new WcmImageAnchor object.
 
Method Summary
 java.lang.String getAltImageLabel()
          Deprecated. Returns the alt label of the active image (selected or unselected image).
 java.lang.String getHTML()
          Deprecated. Returns the WcmImageAnchor HTML.
 java.lang.String getHTML(java.lang.String imageAttributes)
          Deprecated. Returns the WcmImageAnchor HTML.
 java.lang.String getHTML(java.lang.String anchorAttributes, java.lang.String imageAttributes)
          Deprecated. Returns the WcmImageAnchor HTML.
 java.lang.String getImageElementHTML()
          Deprecated. Returns the image HTML of the active image (selected or unselected image).
 java.lang.String getImageElementHTML(java.lang.String imageAttributes)
          Deprecated. Returns the image HTML of the active image (selected or unselected image).
 boolean isSelected()
          Deprecated. Returns true when the image anchor is in a selected state.
 void setAltSelectedImageLabel(WcmString localizedAltImageLabel)
          Deprecated. Sets the selected image alt label.
 void setAltUnSelectedImageLabel(WcmString localizedAltImageLabel)
          Deprecated. Sets the selected image alt label.
 void setSelected(boolean on)
          Deprecated. Sets the WcmImageAnchor to a selected state.
 
Methods inherited from class com.filenet.wcm.toolkit.server.util.ui.WcmAnchor
createNonLocalized, getCloseTagHTML, getHTML, getHTML, getId, getLabel, getLabel, getOpenTagHTML, getOpenTagHTML, getToolTip, getURL, getWindowHeight, getWindowWidth, isDisabled, isHidden, isPopup, setDisabled, setHidden, setId, setNonLocalizedLabel, setOnClick, setOnContextMenu, setPopup, setToolTip, setToolTip, setToolTip, setURL, setURL, setWindowHeight, setWindowWidth, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

LOCALIZED_IMAGE_PATH

public static final WcmString LOCALIZED_IMAGE_PATH
Deprecated. 
The localized image path. It is a WcmString object that can be localized to point to a different location. The default value is set to images/web/localized/US_EN/


selectedImageUrl

protected java.lang.String selectedImageUrl
Deprecated. 
The url path of the selected image.


unSelectedImageUrl

protected java.lang.String unSelectedImageUrl
Deprecated. 
The url path of the unselected image.


altSelectedImageLabel

protected java.lang.String altSelectedImageLabel
Deprecated. 
The label of the HTML image alt attribute for the selected image.


altUnSelectedImageLabel

protected java.lang.String altUnSelectedImageLabel
Deprecated. 
The label of the HTML image alt attribute for the unselected image.


imageAttributes

protected java.lang.String imageAttributes
Deprecated. 
Any additional image HTML attributes.


selected

protected boolean selected
Deprecated. 
Constructor Detail

WcmImageAnchor

public WcmImageAnchor(java.lang.String url,
                      WcmString localizedLabel,
                      java.lang.String selectedImageURL,
                      java.lang.String unSelectedImageURL)
Deprecated. 
Contructs a new WcmImageAnchor object.

Parameters:
url - The url string of the new anchor.
localizedLabel - The localized label of the new anchor.
selectedImageURL - The selected image url path.
unSelectedImageURL - The unselected image url path.

WcmImageAnchor

public WcmImageAnchor(java.lang.String url,
                      java.lang.String label,
                      java.lang.String selectedImageURL,
                      java.lang.String unSelectedImageURL)
Deprecated. 
Contructs a new WcmImageAnchor object.

Parameters:
url - The url string of the new anchor.
label - The label of the new anchor.
selectedImageURL - The selected image url path.
unSelectedImageURL - The unselected image url path.
Method Detail

getHTML

public java.lang.String getHTML(java.lang.String imageAttributes)
Deprecated. 
Returns the WcmImageAnchor HTML.

Overrides:
getHTML in class WcmAnchor
Parameters:
imageAttributes - Any additional image tag attributes.
Returns:
String The WcmImageAnchor HTLM.

getHTML

public java.lang.String getHTML(java.lang.String anchorAttributes,
                                java.lang.String imageAttributes)
Deprecated. 
Returns the WcmImageAnchor HTML.

Parameters:
anchorAttributes - Any additional anchor HTML attributes. For a disabled anchor, the extra attributes will be added to the <span> tag. Otherwise, it is added to the <a> tag.
imageAttributes - Any additional image tag attributes.
Returns:
String The WcmImageAnchor HTLM.

getHTML

public java.lang.String getHTML()
Deprecated. 
Returns the WcmImageAnchor HTML.

Overrides:
getHTML in class WcmAnchor
Returns:
String The WcmIconAnchor HTLM.

getImageElementHTML

public java.lang.String getImageElementHTML()
Deprecated. 
Returns the image HTML of the active image (selected or unselected image).

Returns:
String The image HTLM for the current active image.

setAltSelectedImageLabel

public void setAltSelectedImageLabel(WcmString localizedAltImageLabel)
Deprecated. 
Sets the selected image alt label.

Parameters:
localizedAltImageLabel - The localized label being used for the selected image alt label.

setAltUnSelectedImageLabel

public void setAltUnSelectedImageLabel(WcmString localizedAltImageLabel)
Deprecated. 
Sets the selected image alt label.

Parameters:
localizedAltImageLabel - The localized label being used for the unselected image alt label.

getImageElementHTML

public java.lang.String getImageElementHTML(java.lang.String imageAttributes)
Deprecated. 
Returns the image HTML of the active image (selected or unselected image).

Parameters:
imageAttributes - Any additional image tag attributes.
Returns:
String The image HTLM for the icon.

getAltImageLabel

public java.lang.String getAltImageLabel()
Deprecated. 
Returns the alt label of the active image (selected or unselected image).

Returns:
String The alt label.

setSelected

public void setSelected(boolean on)
Deprecated. 
Sets the WcmImageAnchor to a selected state.

Parameters:
on - true to set the image anchor to a selected state. Otherwise, it is set to an unselected state.

isSelected

public boolean isSelected()
Deprecated. 
Returns true when the image anchor is in a selected state. Otherwise returns false.

Returns:
true or false


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.