com.plumtree.taskapi.portalui
Class TaskAPIUIHTML

java.lang.Object
  com.plumtree.taskapi.portalui.TaskAPIUIHTML

public class TaskAPIUIHTML
extends java.lang.Object

HTML Related TaskAPI functions.

Constructor Summary

TaskAPIUIHTML()

Method Summary

static void	CreateHorizontalSpacerCell(HTMLTableRow myTableRow) Adds a spacer cell with a cell width of 4to the specified HTMLTableRow
static HTMLInput	CreateInputToCell(HTMLTableCell e, HTMLInputTypes type, java.lang.String inputName, java.lang.String alt)
static HTMLSpan	CreateSpanToCell(HTMLTableCell e, PTStyleClass style, java.lang.String content)
static HTMLTable	CreateTable(HTMLElement e, int padding, int spacing, java.lang.String width)
static HTMLTableCell	CreateTableCell(HTMLTableRow e, PTStyleClass style)
static HTMLTableCell	CreateTableCell(HTMLTableRow e, PTStyleClass style, int height, java.lang.String width)
static HTMLTableCell	CreateTableCell(HTMLTableRow e, java.lang.String style)
static HTMLTableCell	CreateTableCell(HTMLTableRow e, java.lang.String style, int height, java.lang.String width)
static HTMLTableCell	CreateTableCell(HTMLTableRow e, java.lang.String value, PTStyleClass style, int height, java.lang.String width)
static HTMLTableCell	CreateTableCell(HTMLTableRow e, java.lang.String value, java.lang.String style, int height, java.lang.String width)
static HTMLTableRow	CreateTableRow(HTMLTable e, PTStyleClass style)
static HTMLTableRow	CreateTableRow(HTMLTable e, java.lang.String style)
static HTMLImg	GetImageConstruct(AActivitySpace owner, PTConstructType construct) Gets an HTML Image element for the specified Plumtree Image Construct.
static HTMLImg	GetSpacerImage(java.lang.String strWidth, java.lang.String strHeight) Gets a blank spacer image element with the specified width and height.
static java.lang.String	HTMLDecode(java.lang.String strValue) Returns a decoded version of the input string, assuming it was a valid HTML encoding.
static java.lang.String	HTMLEncode(java.lang.String strValue) Returns an HTML-encoded version of the input string, or empty string if input is null.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskAPIUIHTML

public TaskAPIUIHTML()

Method Detail

CreateHorizontalSpacerCell

public static void CreateHorizontalSpacerCell(HTMLTableRow myTableRow)

Adds a spacer cell with a cell width of 4to the specified HTMLTableRow

Parameters:

myTableRow - HTMLTableRow to add the spacer cell to

GetImageConstruct

public static HTMLImg GetImageConstruct(AActivitySpace owner,
                                        PTConstructType construct)

Gets an HTML Image element for the specified Plumtree Image Construct.

Parameters:

owner - Current Activityspace.

construct - A Plumtree Image Construct.

Returns:

HTML img element created from the Plumtree Image Construct object.

GetSpacerImage

public static HTMLImg GetSpacerImage(java.lang.String strWidth,
                                     java.lang.String strHeight)

Gets a blank spacer image element with the specified width and height.

Parameters:

strWidth - Width value that goes directly into the width attribute in the HTML img element.

strHeight - Height value that goes directly into the width attribute in the HTML img element.

Returns:

HTMLImg element with a spacer image in the specified width and height.

HTMLEncode

public static java.lang.String HTMLEncode(java.lang.String strValue)

Returns an HTML-encoded version of the input string, or empty string if input is null.

Parameters:

strValue - a string of characters to encode for use as HTML text.

Returns:

an encoded version of the input, or empty string if null.

HTMLDecode

public static java.lang.String HTMLDecode(java.lang.String strValue)

Returns a decoded version of the input string, assuming it was a valid HTML encoding.

Parameters:

strValue - the string to decode.

Returns:

a decoded version of the input.

Throws:

XPNullPointerException - if input is null.

XPUnsupportedEncodingException - if an invalid ampersand escape is found.

CreateTable

public static HTMLTable CreateTable(HTMLElement e,
                                    int padding,
                                    int spacing,
                                    java.lang.String width)

Parameters:

e - Element to add table to, or null to not add it to any element

padding - Table padding

spacing - Table spacing

width - Table width (in percentage or pixels) or null if no width is needed

Returns:

HTMLTable element

CreateTableRow

public static HTMLTableRow CreateTableRow(HTMLTable e,
                                          java.lang.String style)

Parameters:

e - Element to add table to

style - CSS Style for the row or null if no style is needed

Returns:

HTMLTableRow element or null if e is null

CreateTableRow

public static HTMLTableRow CreateTableRow(HTMLTable e,
                                          PTStyleClass style)

Parameters:

e - Element to add table to

style - CSS Style for the row or null if no style is needed

Returns:

HTMLTableRow element or null if e is null

CreateTableCell

public static HTMLTableCell CreateTableCell(HTMLTableRow e,
                                            java.lang.String style)

Parameters:

e - Element to add table to

style - CSS Style for the row or null if no style is needed

Returns:

HTMLTableCell element or null if e is null

CreateTableCell

public static HTMLTableCell CreateTableCell(HTMLTableRow e,
                                            PTStyleClass style)

Parameters:

e - Element to add table to

style - CSS Style for the row or null if no style is needed

Returns:

HTMLTableCell element or null if e is null

CreateTableCell

public static HTMLTableCell CreateTableCell(HTMLTableRow e,
                                            java.lang.String style,
                                            int height,
                                            java.lang.String width)

Parameters:

e - Element to add table to

style - CSS Style for the row or null if no style is needed

height - Table cell height

width - Table cell width (in percentage or pixels)

Returns:

HTMLTableCell element or null if e is null

CreateTableCell

public static HTMLTableCell CreateTableCell(HTMLTableRow e,
                                            PTStyleClass style,
                                            int height,
                                            java.lang.String width)

Parameters:

e - Element to add table to

style - CSS Style for the row or null if no style is needed

height - Table cell height

width - Table cell width (in percentage or pixels)

Returns:

HTMLTableCell element or null if e is null

CreateTableCell

public static HTMLTableCell CreateTableCell(HTMLTableRow e,
                                            java.lang.String value,
                                            java.lang.String style,
                                            int height,
                                            java.lang.String width)

Parameters:

e - Element to add table to

style - CSS Style for the row or null if no style is needed

value - Content to add to table cell, string is html encoded

height - Table cell height

width - Table cell width (in percentage or pixels)

Returns:

HTMLTableCell element or null if e is null

CreateTableCell

public static HTMLTableCell CreateTableCell(HTMLTableRow e,
                                            java.lang.String value,
                                            PTStyleClass style,
                                            int height,
                                            java.lang.String width)

Parameters:

e - Element to add table to

style - CSS Style for the row or null if no style is needed

value - Content to add to table cell, string is html encoded

height - Table cell height

width - Table cell width (in percentage or pixels)

Returns:

HTMLTableCell element or null if e is null

CreateSpanToCell

public static HTMLSpan CreateSpanToCell(HTMLTableCell e,
                                        PTStyleClass style,
                                        java.lang.String content)

Parameters:

e - HTMLTableCell element to add span to

style - CSS Style for the row or null if no style is needed

content - Content to add to table cell, string is html encoded

Returns:

The created HTMLSpan or null if e is null

CreateInputToCell

public static HTMLInput CreateInputToCell(HTMLTableCell e,
                                          HTMLInputTypes type,
                                          java.lang.String inputName,
                                          java.lang.String alt)

Parameters:

e - HTMLTableCell element to add span to

type - Type of input element

inputName - Input name

alt - Alt text

Returns: