GuideTextBox (The Adobe Experience Manager Forms SDK 2022.08.04.00-220800)

java.lang.Object
- com.adobe.cq.sightly.WCMUsePojo
- - com.adobe.aemds.guide.common.GuideNode
  - - com.adobe.aemds.guide.common.GuideField
    - - com.adobe.aemds.guide.common.GuideTextBox

All Implemented Interfaces:

FDField, StyledFDField, java.io.Serializable, Use
```
public class GuideTextBox
extends GuideField
implements java.io.Serializable
```
GuideTextBox class encapsulates basic properties of the adaptive forms TextBox component. Some of the properties that it encapsulates are listed below:
- rows of the textbox
- columns of the textbox
Since:

AEM 6.0

See Also:

Serialized Form

Field Summary
- Fields inherited from class com.adobe.aemds.guide.common.GuideNode
  i18n

Constructor Summary

Constructors
Constructor Description

GuideTextBox()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.Boolean`	`getAllowRichText()`	Returns whether the textbox allows rich Text or not
`int`	`getCols()`	Returns the number of columns in the textbox component
`java.lang.String`	`getGuideFieldType()`	Returns the field type of the Adaptive Forms Component
`java.lang.Boolean`	`getMultiLine()`	Returns whether the textbox allows multiple lines or not
`int`	`getRows()`	Returns the number of rows in the textbox component
`java.lang.String[]`	`getValues()`	TODO : do we really need this here ?

Methods inherited from class com.adobe.aemds.guide.common.GuideField
getAuthoringConfig, getAutocomplete, getAutofillFieldKeyword, getCaptionInlineStyles, getDescriptionVisibility, getErrorSimulatorString, getFieldLayout, getFieldLayoutName, getHelpIndicatorContent, getHideTitle, getIsOldFieldLayout, getIsReadOnly, getIsRequired, getLabelForId, getLongDescription, getPlaceholderText, getShortDescription, getShortDescriptionInlineStyles, getValue, getWidgetInlineStyles, isMandatory, setHelpIndicatorContent

Methods inherited from class com.adobe.aemds.guide.common.GuideNode
activate, checkIfPathIsAbsolute, externalize, getAddMessage, getAppearance, getAuthoringConfigJSON, getBindRef, getClientLibRef, getColspan, getCssClassName, getDescription, getEnabled, getEnabledExp, getError, getFieldInlineStyles, getHeight, getI18n, getId, getInlineCssClass, getInlineStyles, getIsEditMode, getIsRepeatable, getItems, getLayoutPath, getLayoutTabType, getLongDescriptionInlineStyles, getName, getNavTitle, getNodeClass, getNonNavigableProperty, getPath, getQuestionMarkInlineStyles, getRemoveMessage, getResourceSuperType, getResourceType, getResponsiveClasses, getSlingRequest, getStyles, getTargetVersion, getTitle, getToolbarPosition, getVersion, getVisible, getVisibleExp, getWidth, getXssapi, getXssDescription, isDocumentFragmentGroup, isLayoutNavigable, isMenuRequired, isValid, isValidDorTemplateRef, setClientLibRef, setResource, setSlingRequest, syncNode, validate

Methods inherited from class com.adobe.cq.sightly.WCMUsePojo
get, getComponent, getComponentContext, getCurrentDesign, getCurrentPage, getCurrentStyle, getDesigner, getEditContext, getInheritedProperties, getPageManager, getPageProperties, getProperties, getRequest, getResource, getResourceDesign, getResourcePage, getResourceResolver, getResponse, getSlingScriptHelper, getWcmMode, getXSSAPI, init

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GuideTextBox
```
public GuideTextBox()
```
- Method Detail
  - getMultiLine
```
public java.lang.Boolean getMultiLine()
```
    Returns whether the textbox allows multiple lines or not
    
    Returns:
    
    boolean indicating if textbox allows multiple lines or not
  - getAllowRichText
```
public java.lang.Boolean getAllowRichText()
```
    Returns whether the textbox allows rich Text or not
    
    Returns:
    
    boolean indicating if textbox allows rich Text or not
  - getRows
```
public int getRows()
```
    Returns the number of rows in the textbox component
    
    Returns:
    
    Integer representing the number of rows
  - getCols
```
public int getCols()
```
    Returns the number of columns in the textbox component
    
    Returns:
    
    Integer representing the number of columns
  - getValues
```
public java.lang.String[] getValues()
```
    TODO : do we really need this here ?
  - getGuideFieldType
```
public java.lang.String getGuideFieldType()
```
    Returns the field type of the Adaptive Forms Component
    
    Specified by:
    
    getGuideFieldType in interface FDField
    
    Overrides:
    
    getGuideFieldType in class GuideNode
    
    Returns:
    
    String representing guide field type