com.ebasetech.xi.api.controls

Interface BootstrapRowControl

All Superinterfaces:

BackgroundStyleProperties, BorderStyleProperties, ContainerControl, Control, Element, EventOwner, MarginStyleProperties, MessageContainer, PaddingStyleProperties, java.io.Serializable, TextStyleProperties, WebFormEventOwner

public interface BootstrapRowControl
extends ContainerControl, BackgroundStyleProperties, BorderStyleProperties, PaddingStyleProperties, MarginStyleProperties, TextStyleProperties

Bootstrap Row Control

A container representing a row within the bootstrap framework. Outside of this framework it functions as a simple div. Bootstrap Column Controls can be placed in this control.

  <div>
  .. bootstrap column controls
  </div>
  

Further documentation.

Since:

5.4

Method Summary

Modifier and Type	Method and Description
java.lang.String	getHeight() Row height.
java.lang.String	getHorizontalAlignment() How the row is horizontally aligning all immediate child columns
java.lang.String	getRowType() The type of row being represented see #setRowType(String)
java.lang.String	getVerticalAlignment() How the row is vertically aligning all immediate child columns
boolean	isGutter() Have the gutters between columns been enabled.
void	setGutter(boolean enabled) The gutters between columns in our predefined grid classes are removed when gutters are disabled.
void	setHeight(java.lang.String height) Sets the row height, and is equivalent to the CSS height property and any valid value for this CSS property can be used.
void	setHorizontalAlignment(java.lang.String alignment) Horizontally aligns the columns in the row.
void	setRowType(java.lang.String type) The type of bootstrap row can be changed here.
void	setVerticalAlignment(java.lang.String alignment) Vertically aligns the columns in the row.

Methods inherited from interface com.ebasetech.xi.api.controls.ContainerControl

getChildControls

Methods inherited from interface com.ebasetech.xi.api.controls.Control

addCssClass, getAll, getCssClass, getErrorMsgClass, getErrorMsgStyle, getInfoMsgClass, getInfoMsgStyle, getLayoutCell, getNextSiblingControl, getPage, getParentControl, getPreviousSiblingControl, getStyle, getWarningMsgClass, getWarningMsgStyle, hasModifier, hide, isContainer, isDisplayOnly, isDisplayOnlyIncludingParents, isEventField, isHidden, isInheritMsg, isLocalMsg, isNewLine, isShowing, refresh, removeCssClass, requestFocus, setCssClass, setDisplayOnly, setErrorMsgClass, setErrorMsgStyle, setHidden, setInfoMsgClass, setInfoMsgStyle, setNewLine, setStyle, setWarningMsgClass, setWarningMsgStyle, show

Methods inherited from interface com.ebasetech.xi.api.Element

getElementName, getElementType

Methods inherited from interface com.ebasetech.xi.api.MessageContainer

addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessageText, addErrorMessageText, addErrorMessageText, addInfoMessage, addInfoMessage, addInfoMessageText, addInfoMessageText, addInfoMessageText, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessageText, addWarningMessageText, addWarningMessageText, existErrorMessages, existInfoMessages, existMessages, existWarningMessages

Methods inherited from interface com.ebasetech.xi.api.controls.BackgroundStyleProperties

getBackgroundColor, getBackgroundImage, getBackgroundImagePosition, getBackgroundImageRepeat, setBackgroundColor, setBackgroundImage, setBackgroundImagePosition, setBackgroundImageRepeat

Methods inherited from interface com.ebasetech.xi.api.controls.BorderStyleProperties

getBorderColor, getBorderRadius, getBorderStyle, getBorderWidth, getBottomBorderWidth, getLeftBorderWidth, getRightBorderWidth, getTopBorderWidth, setBorderColor, setBorderRadius, setBorderStyle, setBorderWidth, setBottomBorderWidth, setLeftBorderWidth, setRightBorderWidth, setTopBorderWidth

Methods inherited from interface com.ebasetech.xi.api.controls.PaddingStyleProperties

getAllPadding, getBottomPadding, getLeftPadding, getRightPadding, getTopPadding, setAllPadding, setBottomPadding, setLeftPadding, setRightPadding, setTopPadding

Methods inherited from interface com.ebasetech.xi.api.controls.MarginStyleProperties

getAllMargin, getBottomMargin, getLeftMargin, getRightMargin, getTopMargin, setAllMargin, setBottomMargin, setLeftMargin, setRightMargin, setTopMargin

Methods inherited from interface com.ebasetech.xi.api.controls.TextStyleProperties

getLineHeight, getTextBold, getTextColor, getTextDecoration, getTextFont, getTextItalic, getTextSize, setLineHeight, setTextBold, setTextColor, setTextDecoration, setTextFont, setTextItalic, setTextSize

Method Detail

getHeight

java.lang.String getHeight()

Row height. This is equivalent to the CSS height property, and any valid value for this CSS property can be used when setting a value.

Since:

V5.4

See Also:

setHeight(String)

setHeight

void setHeight(java.lang.String height)

Sets the row height, and is equivalent to the CSS height property and any valid value for this CSS property can be used. Setting this property to null removes any existing value.

Examples:

 controls.ROW1.height = "50px";
 controls.ROW1.setHeight("100px");
 

Since:

V5.4

getVerticalAlignment

java.lang.String getVerticalAlignment()

How the row is vertically aligning all immediate child columns

Since:

V5.4

See Also:

setVerticalAlignment(String)

setVerticalAlignment

void setVerticalAlignment(java.lang.String alignment)

Vertically aligns the columns in the row.

Possible values are: Start - Aligns columns to the start (often the top) of the row. Center - Aligns columns to the center of the row. End - Aligns columns to the end (often the bottom) of the row. Example:

 controls.ROW1.verticalAlignment = "Start";
 controls.ROW1.setVerticalAlignment("Center");
 

Since:

V5.4

getHorizontalAlignment

java.lang.String getHorizontalAlignment()

How the row is horizontally aligning all immediate child columns

Since:

V5.4

See Also:

setHorizontalAlignment(String)

setHorizontalAlignment

void setHorizontalAlignment(java.lang.String alignment)

Horizontally aligns the columns in the row.

Possible values are: Start - Aligns columns to the top (often the left) of the row. Center - Aligns columns to the center of the row. End - Aligns columns to the bottom (often the right) of the row. Around - Aligns columns in the row such that there is an equal gap between each of the columns and the start and finish of the row. Between - Aligns columns in the row such that the gap is between the columns and not between the start and end of the row. Example:

 controls.ROW1.horizontalAlignment = "Start";
 controls.ROW1.setHorizontalAlignment("Center");
 

Since:

V5.4

isGutter

boolean isGutter()

Have the gutters between columns been enabled.

Since:

V5.4

See Also:

setGutter(boolean)

setGutter

void setGutter(boolean enabled)

The gutters between columns in our predefined grid classes are removed when gutters are disabled. This removes the negative margins from the row and the horizontal padding from all immediate children columns.

By default guttering is enabled.

Example:

 controls.ROW1.gutter = false;
 controls.ROW1.setGutter(true);
 

Since:

V5.4

getRowType

java.lang.String getRowType()

The type of row being represented see #setRowType(String)

setRowType

void setRowType(java.lang.String type)

The type of bootstrap row can be changed here. These can have a semantic difference in the html and usually subjected to subtle bootstrap styling differences.

Possible values are: Row - the standard bootstrap form. Form Row - for more compact form layouts.

By default the type is row.

Since:

V5.4