Package com.ebasetech.xi.api.controls

Interface BorderStyleProperties

All Known Subinterfaces:
AddRowButtonProperties, ArticleControl, AsideControl, AudioControl, BasicBlockControl, BootstrapColumnControl, BootstrapContainerControl, BootstrapRowControl, ButtonColumnControl, ButtonColumnProperties, ButtonControl, ButtonControlProperties, CanvasControl, CellStyleProperties, ColumnStyleProperties, EbaseButtonControlProperties, EditorInputProperties, FieldColumnControl, FieldControl, FieldHyperlinkProperties, FieldLayout, FieldLayoutCell, FileUploadControl, FileUploadTextControl, FinishButtonControl, FooterControl, GridCellControl, GridControl, GroupAndPagePanelProperties, GroupAndPageTextProperties, GroupPanelControl, HeaderControl, HeadingControl, HorizontalMenuControl, HyperlinkControl, HyperlinkStateProperties, IFrameControl, ImageColumnControl, ImageControl, ImageStyleProperties, InitiateUploadControl, ListControl, ListHyperlinkControl, ListItemControl, ListPanelControl, MainControl, MenuControl, MessageStyleProperties, MultimediaControlProperties, NavControl, NavigationBarStyleProperties, NextPageButtonControl, PageControl, PageNavigationButtonStyle, PageNavigationPanel, PagePanelControl, PanelControl, PDFPageStyleProperties, PrevPageButtonControl, RepeatingStyleProperties, RepeatingTableControl, RepeatingTableListControl, RepeatingTableListRowControl, RepeatingTableRowControl, RestoreButtonControl, SaveButtonControl, SectionControl, TableCellStyleProperties, TableColumnHeaderProperties, TableControlStyleProperties, TableControlTextProperties, TableRowStyleProperties, TableSortProperties, TextControl, VerticalMenuControl, VideoControl
public interface BorderStyleProperties
The BorderStyleProperties interface represents common border styling properties. It is used wherever a border can be styled.

Further documentation.

Since:
V4.4

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getBorderColor()
    Border color applied to all borders.
    java.lang.String getBorderRadius()
    Border radius.
    java.lang.String getBorderStyle()
    Border style applied to all borders.
    java.lang.String getBorderWidth()
    Border width applied to all four borders.
    java.lang.String getBottomBorderWidth()
    Bottom border width, overriding property borderWidth.
    java.lang.String getLeftBorderWidth()
    Left border width, overriding property borderWidth.
    java.lang.String getRightBorderWidth()
    Right border width, overriding property borderWidth.
    java.lang.String getTopBorderWidth()
    Top border width, overriding property borderWidth.
    void setBorderColor​(java.lang.String borderColor)
    Sets border color.
    void setBorderRadius​(java.lang.String borderRadius)
    Sets border radius.
    void setBorderStyle​(java.lang.String borderStyle)
    Sets border style.
    void setBorderWidth​(java.lang.String borderWidth)
    Sets the border width applied to all four borders.
    void setBottomBorderWidth​(java.lang.String bottomBorderWidth)
    Sets the bottom border width, overriding property borderWidth.
    void setLeftBorderWidth​(java.lang.String leftBorderWidth)
    Sets the left border width, overriding property borderWidth.
    void setRightBorderWidth​(java.lang.String rightBorderWidth)
    Sets the right border width, overriding property borderWidth.
    void setTopBorderWidth​(java.lang.String topBorderWidth)
    Sets the top border width, overriding property borderWidth.

  • Method Details

    • getBorderWidth

      java.lang.String getBorderWidth()
      Border width applied to all four borders. This property is effective only when the leftBorderWidth, rightBorderWidth, topBorderWidth and bottomBorderWidth properties are all not specified. This is equivalent to the CSS border-width property, and any valid value for this CSS property can be used when setting a value.
      Since:
      V4.4
      See Also:
      setBorderWidth(String)

    • setBorderWidth

      void setBorderWidth​(java.lang.String borderWidth)
      Sets the border width applied to all four borders. This property is effective only when the leftBorderWidth, rightBorderWidth, topBorderWidth and bottomBorderWidth properties are all not specified. This is equivalent to the CSS border-width property, and any valid value for this CSS property can be used when setting a value. Setting this property to null removes any existing value.

      Note that for a border to be visible, the borderStyle and borderColor properties are also required.

      Examples: 

       controls.PANEL1.borderWidth = "2px";
 controls.PANEL1.borderStyle = "solid";
 controls.PANEL1.borderColor = "black";
 controls.TEXT1.setBorderWidth("medium");
      Since:
      V4.4

    • getTopBorderWidth

      java.lang.String getTopBorderWidth()
      Top border width, overriding property borderWidth. This is equivalent to the CSS border-top-width property, and any valid value for this CSS property can be used when setting a value.
      Since:
      V4.4
      See Also:
      setTopBorderWidth(String)

    • setTopBorderWidth

      void setTopBorderWidth​(java.lang.String topBorderWidth)
      Sets the top border width, overriding property borderWidth. This is equivalent to the CSS border-top-width property, and any valid value for this CSS property can be used when setting a value. Setting this property to null removes any existing value.

      Note that for a border to be visible, the borderStyle and borderColor properties are also required.

      Examples: 

       controls.PANEL1.topBorderWidth = "2px";
 controls.PANEL1.borderStyle = "solid";
 controls.PANEL1.borderColor = "black";
 controls.TEXT1.setTopBorderWidth("medium");
      Since:
      V4.4

    • getRightBorderWidth

      java.lang.String getRightBorderWidth()
      Right border width, overriding property borderWidth. This is equivalent to the CSS border-right-width property, and any valid value for this CSS property can be used when setting a value.
      Since:
      V4.4
      See Also:
      setRightBorderWidth(String)

    • setRightBorderWidth

      void setRightBorderWidth​(java.lang.String rightBorderWidth)
      Sets the right border width, overriding property borderWidth. This is equivalent to the CSS border-right-width property, and any valid value for this CSS property can be used when setting a value. Setting this property to null removes any existing value.

      Note that for a border to be visible, the borderStyle and borderColor properties are also required.

      Examples: 

       controls.PANEL1.rightBorderWidth = "2px";
 controls.PANEL1.borderStyle = ControlConstants.BORDER_STYLE_SOLID;
 controls.PANEL1.borderColor = "black";
 controls.TEXT1.setRightBorderWidth("medium");
      Since:
      V4.4

    • getBottomBorderWidth

      java.lang.String getBottomBorderWidth()
      Bottom border width, overriding property borderWidth. This is equivalent to the CSS border-bottom-width property, and any valid value for this CSS property can be used when setting a value.
      Since:
      V4.4
      See Also:
      setBottomBorderWidth(String)

    • setBottomBorderWidth

      void setBottomBorderWidth​(java.lang.String bottomBorderWidth)
      Sets the bottom border width, overriding property borderWidth. This is equivalent to the CSS border-bottom-width property, and any valid value for this CSS property can be used when setting a value. Setting this property to null removes any existing value.

      Note that for a border to be visible, the borderStyle and borderColor properties are also required.

      Examples: 

       controls.PANEL1.bottomBorderWidth = "2px";
 controls.PANEL1.borderStyle = "solid";
 controls.PANEL1.borderColor = "black";
 controls.TEXT1.setBottomBorderWidth("medium");
      Since:
      V4.4

    • getLeftBorderWidth

      java.lang.String getLeftBorderWidth()
      Left border width, overriding property borderWidth. This is equivalent to the CSS border-left-width property, and any valid value for this CSS property can be used when setting a value.
      Since:
      V4.4
      See Also:
      setLeftBorderWidth(String)

    • setLeftBorderWidth

      void setLeftBorderWidth​(java.lang.String leftBorderWidth)
      Sets the left border width, overriding property borderWidth. This is equivalent to the CSS border-left-width property, and any valid value for this CSS property can be used when setting a value. Setting this property to null removes any existing value.

      Note that for a border to be visible, the borderStyle and borderColor properties are also required.

      Examples: 

       controls.PANEL1.leftBorderWidth = "2px";
 controls.PANEL1.borderStyle = "solid";
 controls.PANEL1.borderColor = "black";
 controls.TEXT1.setLeftBorderWidth("medium");
      Since:
      V4.4

    • getBorderStyle

      java.lang.String getBorderStyle()
      Border style applied to all borders. If configured the value will be one of the following:
      • None
      • Solid
      • Dotted
      • Dashed
      • Double
      • Groove
      • Ridged
      Since:
      V4.4
      See Also:
      setBorderStyle(String)

    • setBorderStyle

      void setBorderStyle​(java.lang.String borderStyle)
      Sets border style.

      Supported values:

      ValueConstant
      NoneControlConstants.NONE
      SolidControlConstants.BORDER_STYLE_SOLID
      DottedControlConstants.BORDER_STYLE_DOTTED
      DashedControlConstants.BORDER_STYLE_DASHED
      DoubleControlConstants.BORDER_STYLE_DOUBLE
      GrooveControlConstants.BORDER_STYLE_GROOVE
      RidgedControlConstants.BORDER_STYLE_RIDGED

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

      Note that for a border to be visible, a border width property and the borderColor property is also required.

      Examples: 

       controls.PANEL1.borderStyle = ControlConstants.BORDER_STYLE_SOLID;
 controls.PANEL1.borderWidth = "2px";
 controls.PANEL1.borderColor = "black";
 controls.TEXT1.setBorderStyle(ControlConstants.NONE);
      Since:
      V4.4

    • getBorderColor

      java.lang.String getBorderColor()
      Border color applied to all borders. This is equivalent to the CSS border-color property, and any valid value for this CSS property can be used when setting a value.
      Since:
      V4.4
      See Also:
      setBorderColor(String)

    • setBorderColor

      void setBorderColor​(java.lang.String borderColor)
      Sets border color. This is equivalent to the CSS border-color property, and any valid value for this CSS property can be used when setting a value. Setting this property to null removes any existing value.

      Note that for a border to be visible, a border width property and the borderStyle property is also required.

      Examples: 

       controls.PANEL1.borderColor = "black";
 controls.PANEL1.borderWidth = "2px";
 controls.PANEL1.borderStyle = "solid";
 controls.TEXT1.setBorderColor("#ff00ff");
      Since:
      V4.4

    • getBorderRadius

      java.lang.String getBorderRadius()
      Border radius.

      Further documentation.

      Since:
      V4.4
      See Also:
      setBorderRadius(String)

    • setBorderRadius

      void setBorderRadius​(java.lang.String borderRadius)
      Sets border radius. Up to four values can be specified (see examples below) corresponding to the border corner radius for the top left, top right, bottom right and bottom left corners respectively.

      Note that it is not possible to set vertical radii properties (as is possible with the CSS3 border-radius property).

      Setting this property to null removes any existing value.

      Implementation:
      Border radius is implemented using a combination of the CSS3 border-radius property and a mix of non-standard CSS properties for older browsers that do not support border-radius. Although CSS3 is not yet fully released, the part of the specification containing the border-radius property is considered stable. For Internet Explorer 6, 7 and 8, the CSS3 PIE plugin is used. This property is supported by all browsers supported by Ebase Xi with the exception of Opera 10.0, where it is ignored and square borders will be shown.

      Further documentation.

      Examples: 

       // set corners: top left, top right, bottom right, bottom left 
 controls.PANEL1.borderRadius = "20px 40px 40px 80px";
 // set top left and bottom right corners to 20px, top right and bottom left borders to 40px
 controls.PANEL1.borderRadius = "20px, 40px";
 // set all corners to a radius of 20px
 controls.PANEL1.borderRadius = "20px";
      Since:
      V4.4