com.ebasetech.xi.api.controls

Interface ListLayout

All Superinterfaces:

Layout

public interface ListLayout
extends Layout

Method Summary

Modifier and Type	Method and Description
java.lang.String	getContainingListType() The containing list type, can be either "ordered" or "unordered".
java.lang.String	getLayoutClass() Returns the list of CSS classes configured for the containing ordered or unordered list tag of the layout.
java.lang.String	getLayoutStyle() Returns the inline CSS style configured for the containing ordered or unordered list tag of the layout.
java.lang.String	getLiClass() Returns the list of CSS classes configured for the containing ordered or unordered list tag of the layout.
java.lang.String	getListStyleImage() URL of the list item marker image.
java.lang.String	getListStylePosition() The list style position.
java.lang.String	getListStyleType() The list style type.
java.lang.String	getLiStyle() Returns the inline CSS style configured for the containing ordered or unordered list tag of the layout.
void	setContainingListType(java.lang.String listType) Sets the list type.
void	setLayoutClass(java.lang.String layoutClass) Sets one or more CSS classes to the ordered or unordered list tag used to contain the layout.
void	setLayoutStyle(java.lang.String layoutStyle) Sets the inline CSS style to be applied to the ordered or unordered list tag used to contain the layout.
void	setLiClass(java.lang.String layoutClass) Sets one or more CSS classes to the ordered or unordered list tag used to contain the layout.
void	setListStyleImage(java.lang.String listStyleImage) Sets the URL of the list item marker image.
void	setListStylePosition(java.lang.String listStylePosition) Sets the list style position.
void	setListStyleType(java.lang.String listStyleType) Sets the list style type.
void	setLiStyle(java.lang.String layoutStyle) Sets the inline CSS style to be applied to the ordered or unordered list tag used to contain the layout.

Method Detail

getLayoutClass

java.lang.String getLayoutClass()

Returns the list of CSS classes configured for the containing ordered or unordered list tag of the layout.

These classes are configured in the designer using the Advanced Properties button within the layout properties Styling Assistant.

Further documentation.

Since:

V5.3

setLayoutClass

void setLayoutClass(java.lang.String layoutClass)

Sets one or more CSS classes to the ordered or unordered list tag used to contain the layout. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

These classes are configured in the designer using the Advanced Properties button within the layout properties Styling Assistant.

Further documentation.

Since:

V5.3

getLayoutStyle

java.lang.String getLayoutStyle()

Returns the inline CSS style configured for the containing ordered or unordered list tag of the layout.

This inline style is configured in the designer using the Advanced Properties button within the layout properties Styling Assistant.

Further documentation.

Since:

V5.3

See Also:

setLayoutStyle(String)

setLayoutStyle

void setLayoutStyle(java.lang.String layoutStyle)

Sets the inline CSS style to be applied to the ordered or unordered list tag used to contain the layout. Style is entered as for the HTML style parameter.

This inline style is configured in the designer using the Advanced Properties button within the layout properties Styling Assistant.

Further documentation.

Since:

V5.3

getLiClass

java.lang.String getLiClass()

Returns the list of CSS classes configured for the containing ordered or unordered list tag of the layout.

These classes are configured in the designer using the Advanced Properties button within the layout properties Styling Assistant.

Further documentation.

Since:

V5.3

See Also:

setLiClass(String)

setLiClass

void setLiClass(java.lang.String layoutClass)

Sets one or more CSS classes to the ordered or unordered list tag used to contain the layout. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

These classes are configured in the designer using the Advanced Properties button within the layout properties Styling Assistant.

Further documentation.

Since:

V5.3

getLiStyle

java.lang.String getLiStyle()

Returns the inline CSS style configured for the containing ordered or unordered list tag of the layout.

This inline style is configured in the designer using the Advanced Properties button within the layout properties Styling Assistant.

Further documentation.

Since:

V5.3

See Also:

setLiStyle(String)

setLiStyle

void setLiStyle(java.lang.String layoutStyle)

Sets the inline CSS style to be applied to the ordered or unordered list tag used to contain the layout. Style is entered as for the HTML style parameter.

This inline style is configured in the designer using the Advanced Properties button within the layout properties Styling Assistant.

Further documentation.

Since:

V5.3

getContainingListType

java.lang.String getContainingListType()

The containing list type, can be either "ordered" or "unordered".

Since:

V5.3

setContainingListType

void setContainingListType(java.lang.String listType)

Sets the list type. Can be either "ordered" or "unordered".

Since:

V5.3

getListStyleType

java.lang.String getListStyleType()

The list style type. See setListStyleType(String) for details of supported values when setting this property.

Since:

V5.3

setListStyleType

void setListStyleType(java.lang.String listStyleType)

Sets the list style type. Any valid value for the CSS list-style-type property can be used.

Since:

V5.3

getListStylePosition

java.lang.String getListStylePosition()

The list style position. Supported values are 'inside' and 'outside'.

Since:

V5.3

setListStylePosition

void setListStylePosition(java.lang.String listStylePosition)

Sets the list style position. Supported values are 'inside' and 'outside'.

Since:

V5.3

getListStyleImage

java.lang.String getListStyleImage()

URL of the list item marker image.

Further documentation.

Since:

V5.3

setListStyleImage

void setListStyleImage(java.lang.String listStyleImage)

Sets the URL of the list item marker image.

Further documentation.

Since:

V5.3