com.ebasetech.xi.api.controls

Interface BackgroundStyleProperties

All Known Subinterfaces:

AddRowButtonProperties, BasicBlockControl, BootstrapColumnControl, BootstrapContainerControl, BootstrapRowControl, ButtonColumnControl, ButtonColumnProperties, ButtonControl, ButtonControlProperties, CanvasControl, CellStyleProperties, ColumnStyleProperties, EbaseButtonControlProperties, EditorInputProperties, FieldColumnControl, FieldControl, FieldHyperlinkProperties, FieldLayout, FieldLayoutCell, FinishButtonControl, FooterControl, FormHeaderProperties, GridCellControl, GridControl, GroupAndPagePanelProperties, GroupAndPageTextProperties, GroupPanelControl, HeaderControl, HorizontalMenuControl, HyperlinkControl, HyperlinkStateProperties, ImageColumnControl, ListControl, ListHyperlinkControl, ListItemControl, ListPanelControl, MenuControl, MenuStateProperties, MessageStyleProperties, NavControl, NavigationBarStyleProperties, NextPageButtonControl, PageControl, PageNavigationButtonStyle, PageNavigationPanel, PagePanelControl, PanelControl, PDFPageStyleProperties, PrevPageButtonControl, RepeatingStyleProperties, RepeatingTableControl, RepeatingTableListControl, RepeatingTableListRowControl, RepeatingTableRowControl, RestoreButtonControl, SaveButtonControl, SectionControl, TableAddRowCellProperties, TableCellStyleProperties, TableColumnHeaderProperties, TableControlStyleProperties, TableControlTextProperties, TableRowStyleProperties, TextControl, VerticalMenuControl

public interface BackgroundStyleProperties

The BackgroundStyleProperties interface represents common background styling properties. It is used wherever a background can be styled.

Further documentation.

Since:

V4.4

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBackgroundColor() Background color.
java.lang.String	getBackgroundImage() URL of the background image.
java.lang.String	getBackgroundImagePosition() Background image position.
java.lang.String	getBackgroundImageRepeat() Background image repeat property.
void	setBackgroundColor(java.lang.String backgroundColor) Sets the background color, this is equivalent to the CSS background-color property and any valid value for this CSS property can be used.
void	setBackgroundImage(java.lang.String backgroundImage) Sets the URL of the background image.
void	setBackgroundImagePosition(java.lang.String backgroundImagePosition) Sets the background image position.
void	setBackgroundImageRepeat(java.lang.String backgroundImageRepeat) Sets the background image repeat property.

Method Detail

getBackgroundColor

java.lang.String getBackgroundColor()

Background color. This is equivalent to the CSS background-color property, and any valid value for this CSS property can be used when setting a value.

Since:

V4.4

See Also:

setBackgroundColor(String)

setBackgroundColor

void setBackgroundColor(java.lang.String backgroundColor)

Sets the background color, this is equivalent to the CSS background-color property and any valid value for this CSS property can be used. Setting this property to null removes any configured value.

Examples:

 controls.PANEL1.backgroundColor = "#808080";
 controls.TEXT1.setBackgroundColor("yellow");
 

Since:

V4.4

getBackgroundImage

java.lang.String getBackgroundImage()

URL of the background image.

Since:

V4.4

See Also:

setBackgroundImage(String)

setBackgroundImage

void setBackgroundImage(java.lang.String backgroundImage)

Sets the URL of the background image.

A URL can be either absolute or relative.

• An absolute URL begins with a protocol, usually http e.g. http://www.ebasetech.com. Note that the protocol is required for an absolute URL; if the protocol is missing, the URL will be treated as a relative URL.
• A relative URL does not begin with a protocol and is resolved as being relative to the web application root. In the supplied Tomcat system, this is ../UfsServer/tomcat/webapps/ufs e.g. a relative URL of images/helpimage1.gif will be resolved as ../UfsServer/tomcat/webapps/ufs/images/helpimage1.gif.

Examples:

 controls.PANEL1.backgroundImage = "http://www.ebasetech.com/images/logo.gif";
 controls.PANEL1.setBackgroundImage("images/logo.gif");
 

Since:

V4.4

getBackgroundImagePosition

java.lang.String getBackgroundImagePosition()

Background image position. If configured the value will be one of the following:

• Top Center
• Top Left
• Top Right
• Center Center
• Center Left
• Center Right
• Bottom Center
• Bottom Left
• Bottom Right

Since:

V4.4

See Also:

setBackgroundImagePosition(String)

setBackgroundImagePosition

void setBackgroundImagePosition(java.lang.String backgroundImagePosition)

Sets the background image position.

Supported values:

Value	Constant
Top Center	ControlConstants.IMAGE_POSITION_TOP_CENTER
Top Left	ControlConstants.IMAGE_POSITION_TOP_LEFT
Top Right	ControlConstants.IMAGE_POSITION_TOP_RIGHT
Center Center	ControlConstants.IMAGE_POSITION_CENTER_CENTER
Center Left	ControlConstants.IMAGE_POSITION_CENTER_LEFT
Center Right	ControlConstants.IMAGE_POSITION_CENTER_RIGHT
Bottom Center	ControlConstants.IMAGE_POSITION_BOTTOM_CENTER
Bottom Left	ControlConstants.IMAGE_POSITION_BOTTOM_LEFT
Bottom Right	ControlConstants.IMAGE_POSITION_BOTTOM_RIGHT

Setting a value of null removes any existing value for the property.

Examples:

 controls.PANEL1.backgroundImagePosition = ControlConstants.IMAGE_POSITION_BOTTOM_RIGHT;
 controls.PANEL1.setBackgroundImagePosition(ControlConstants.IMAGE_POSITION_CENTER_CENTER);
 

Since:

V4.4

getBackgroundImageRepeat

java.lang.String getBackgroundImageRepeat()

Background image repeat property. This is equivalent to the CSS background-repeat property. If configured the value will be one of the following:

• no-repeat
• repeat
• repeat-x
• repeat-y

Since:

V4.4

See Also:

setBackgroundImageRepeat(String)

setBackgroundImageRepeat

void setBackgroundImageRepeat(java.lang.String backgroundImageRepeat)

Sets the background image repeat property. This is equivalent to the CSS background-repeat property.

Supported values:

Value	Constant
no-repeat	ControlConstants.IMAGE_NO_REPEAT
repeat	ControlConstants.IMAGE_REPEAT
repeat-x	ControlConstants.IMAGE_REPEAT-X
repeat-y	ControlConstants.IMAGE_REPEAT-Y

Setting a value of null removes any existing value for the property.

Examples:

 controls.PANEL1.backgroundImageRepeat = ControlConstants.IMAGE_REPEAT;
 controls.PANEL1.setBackgroundImagePosition(ControlConstants.IMAGE_REPEAT-X);
 

Since:

V4.4