com.plumtree.portalpages.portlets.userprofile.infrastructure
Interface IProfileCell

All Known Implementing Classes:

ProfileCell

public interface IProfileCell

Author:

chrisb

Method Summary

HTMLAnchor	GetHTMLAnchor() Returns an HTMLAnchor element if the Profile Cell is using a click through URI and/or an onclick action.
HTMLImg	GetImage() If there is an image set on the Profile Cell it will return the image object
java.lang.String	GetMouseOver() Returns a description of the ProfileCell that will be shown as mouse-over (pop-up) text.
java.lang.String	GetSubText() Returns the sub text that will be displayed below the text of the cell.
java.lang.String	GetText() Returns the text to go in the ProfileCell.
boolean	isHTML() Tells the caller whether or not this ProfileCell contains HTML.
boolean	isImg() Tells the caller if the cell that is being displayed is an image.

Method Detail

isHTML

boolean isHTML()

Tells the caller whether or not this ProfileCell contains HTML. If it has markup, the caller will not encode it so that the markup gets interpreted. If it returns false, you're telling the caller that you want to HTMLEncode the text.

Returns:

Whether or not this ProfileCell contains HTML.

isImg

boolean isImg()

Tells the caller if the cell that is being displayed is an image. If the cell is an image it is displayed differently in the TablePage.

Returns:

boolean

GetHTMLAnchor

HTMLAnchor GetHTMLAnchor()

Returns an HTMLAnchor element if the Profile Cell is using a click through URI and/or an onclick action.

Returns:

HTMLAnchor the anchor element that is used for the cell.

GetImage

HTMLImg GetImage()

If there is an image set on the Profile Cell it will return the image object

Returns:

HTMLImg

GetMouseOver

java.lang.String GetMouseOver()

Returns a description of the ProfileCell that will be shown as mouse-over (pop-up) text. This method is optional. If you don't want to have a mouse-over, implement this method to return an empty string.

Returns:

A description of the ProfileCell to be shown as a mouse-over.

GetSubText

java.lang.String GetSubText()

Returns the sub text that will be displayed below the text of the cell. This sub text will not be associated with the click through URI.

Returns:

boolean

GetText

java.lang.String GetText()

Returns the text to go in the ProfileCell. This method must return a value.

Returns:

The text to display in the ProfileCell.