Package com.ebasetech.xi.api.controls

Interface BackgroundStyleProperties

All Known Subinterfaces:
AddRowButtonProperties, ArticleControl, AsideControl, BasicBlockControl, BootstrapColumnControl, BootstrapContainerControl, BootstrapRowControl, ButtonColumnControl, ButtonColumnProperties, ButtonControl, ButtonControlProperties, CanvasControl, CellStyleProperties, ColumnStyleProperties, EbaseButtonControlProperties, EditorInputProperties, FieldColumnControl, FieldControl, FieldHyperlinkProperties, FieldLayout, FieldLayoutCell, FileUploadControl, FileUploadTextControl, FinishButtonControl, FooterControl, FormHeaderProperties, GridCellControl, GridControl, GroupAndPagePanelProperties, GroupAndPageTextProperties, GroupPanelControl, HeaderControl, HeadingControl, HorizontalMenuControl, HyperlinkControl, HyperlinkStateProperties, ImageColumnControl, InitiateUploadControl, ListControl, ListHyperlinkControl, ListItemControl, ListPanelControl, MainControl, 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 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 Details

    • 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 ..userdata/apps/ebase/webapp e.g. a relative URL of images/helpimage1.gif will resolve to ..userdata/apps/ebase/webapp/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:

      ValueConstant
      Top CenterControlConstants.IMAGE_POSITION_TOP_CENTER
      Top LeftControlConstants.IMAGE_POSITION_TOP_LEFT
      Top RightControlConstants.IMAGE_POSITION_TOP_RIGHT
      Center CenterControlConstants.IMAGE_POSITION_CENTER_CENTER
      Center LeftControlConstants.IMAGE_POSITION_CENTER_LEFT
      Center RightControlConstants.IMAGE_POSITION_CENTER_RIGHT
      Bottom CenterControlConstants.IMAGE_POSITION_BOTTOM_CENTER
      Bottom LeftControlConstants.IMAGE_POSITION_BOTTOM_LEFT
      Bottom RightControlConstants.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:

      ValueConstant
      no-repeatControlConstants.IMAGE_NO_REPEAT
      repeatControlConstants.IMAGE_REPEAT
      repeat-xControlConstants.IMAGE_REPEAT-X
      repeat-yControlConstants.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