com.plumtree.portalpages.portlets.userprofile.infrastructure
Class ProfileCell

java.lang.Object
  com.plumtree.portalpages.portlets.userprofile.infrastructure.ProfileCell

All Implemented Interfaces:

IProfileCell

public final class ProfileCell
extends java.lang.Object
implements IProfileCell

Author:

chrisb To change this generated comment edit the template variable "typecomment": Window>Preferences>Java>Templates. To enable and disable the creation of type comments go to Window>Preferences>Java>Code Generation.

Constructor Summary

ProfileCell(HTMLImg Image)
Constructs a Profile Cell and sets it as an image.

ProfileCell(java.lang.String text, java.lang.String subtext, java.lang.String mouseover, HTMLAnchor Anchor, boolean isHTML)
Constructs a ReferenceProfileCell and sets the text, mouseover, URI and isHTML properties.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProfileCell

public ProfileCell(java.lang.String text,
                   java.lang.String subtext,
                   java.lang.String mouseover,
                   HTMLAnchor Anchor,
                   boolean isHTML)

Constructs a ReferenceProfileCell and sets the text, mouseover, URI and isHTML properties.

Parameters:

text - The text to display in this ProfileCell.

subtext - The text that will be displayed below the main text of the cell

mouseover - The description of this ProfileCell to display as a mouseover.

Anchor - action for the profile cell if the URI is set.

isHTML - Whether or not this ProfileCell contains markup.

ProfileCell

public ProfileCell(HTMLImg Image)

Constructs a Profile Cell and sets it as an image. This needs to be handled differently in order for the upper most HTMLElementCollection to be able to retrieve the image server URL.

Parameters:

Image -

Method Detail

isHTML

public boolean isHTML()

Description copied from interface: IProfileCell

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.

Specified by:

isHTML in interface IProfileCell

Returns:

Whether or not this ProfileCell contains HTML.

See Also:

com.plumtree.xpportlets.expatriate.ext.introspective.ProfileItem#isHTML()

isImg

public boolean isImg()

Description copied from interface: IProfileCell

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.

Specified by:

isImg in interface IProfileCell

Returns:

boolean

See Also:

com.plumtree.portlets.introspective2.IProfileCell#isImg()

GetHTMLAnchor

public HTMLAnchor GetHTMLAnchor()

Description copied from interface: IProfileCell

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

Specified by:

GetHTMLAnchor in interface IProfileCell

Returns:

HTMLAnchor the anchor element that is used for the cell.

See Also:

com.plumtree.portlets.introspective2.IProfileCell#GetOnClickAction()

GetImage

public HTMLImg GetImage()

Description copied from interface: IProfileCell

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

Specified by:

GetImage in interface IProfileCell

Returns:

HTMLImg

See Also:

com.plumtree.portlets.introspective2.IProfileCell#GetImage()

GetMouseOver

public java.lang.String GetMouseOver()

Description copied from interface: IProfileCell

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.

Specified by:

GetMouseOver in interface IProfileCell

Returns:

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

See Also:

com.plumtree.xpportlets.expatriate.ext.introspective.ProfileItem#getMouseOver()

GetSubText

public java.lang.String GetSubText()

Description copied from interface: IProfileCell

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.

Specified by:

GetSubText in interface IProfileCell

Returns:

GetText

public java.lang.String GetText()

Description copied from interface: IProfileCell

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

Specified by:

GetText in interface IProfileCell

Returns:

The text to display in the ProfileCell.

See Also:

com.plumtree.xpportlets.expatriate.ext.introspective.ProfileItem#getText()