Package com.ebasetech.xi.api.controls

Interface HeadingControl

All Superinterfaces:

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

public interface HeadingControl
extends Control, BackgroundStyleProperties, TextStyleProperties, PaddingStyleProperties, MarginStyleProperties, BorderStyleProperties, AriaControlProperties

Heading Control

A general purpose control that wraps content in a Heading H1-H6 tag:

  <H1>
  .. child controls
  </H1>
  

Further documentation.

Since:

V5.9

Method Summary

Modifier and Type	Method	Description
int	getLevel()	Heading level.
Text	getText()	Returns the Text object for the heading.
void	setLevel(int level)	Sets the heading level, accepted values are 1 - 6 and correspond to changing the HTML tag to <h1> - <h6>

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

addAriaCustomAttribute, getAriaCustomAttributes, getAriaDescribedBy, getAriaLabelledBy, getAriaLabelText, getAriaRole, removeAriaCustomAttribute, setAriaCustomAttributes, setAriaRole

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.Control

addCssClass, getAll, getCssClass, getErrorMsgClass, getErrorMsgStyle, getInfoMsgClass, getInfoMsgStyle, getLayoutCell, getNextSiblingControl, getPage, getParentControl, getPreviousSiblingControl, getRootHtmlElementProperties, 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.controls.MarginStyleProperties

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

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.PaddingStyleProperties

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

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 Details

getLevel

int getLevel()

Heading level. 1 - 6 for H1, H2, H3, H4, H5, H6 heading html element

setLevel

void setLevel(int level)

Sets the heading level, accepted values are 1 - 6 and correspond to changing the HTML tag to <h1> - <h6>

Since:

V5.9

getText

Text getText()

Returns the Text object for the heading.