com.adobe.cq.testing.client.components.foundation.form

Class Text

java.lang.Object

com.adobe.cq.testing.client.components.AbstractComponent

com.adobe.cq.testing.client.components.foundation.form.AbstractFormFieldComponent

com.adobe.cq.testing.client.components.foundation.form.Text

public class Text
extends AbstractFormFieldComponent

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_IS_MULTI_VALUE
static String	PROP_IS_READ_ONLY
static String	PROP_STYLE_COLS
static String	PROP_STYLE_ROWS
static String	PROP_STYLE_WIDTH
static String	RESOURCE_TYPE

Fields inherited from class com.adobe.cq.testing.client.components.foundation.form.AbstractFormFieldComponent

OPT_CONSTRAINT_TYPE_DATE, OPT_CONSTRAINT_TYPE_EMAIL, OPT_CONSTRAINT_TYPE_NAME, OPT_CONSTRAINT_TYPE_NUMERIC, PROP_CONSTRAINT_MESSAGE, PROP_CONSTRAINT_TYPE, PROP_DEFAULT_VALUE, PROP_DESCRIPTION, PROP_ELEMENT_NAME, PROP_HIDE_TITLE, PROP_REQUIRED, PROP_REQUIRED_MESSAGE, PROP_STYLING_CSS, PROP_TITLE

Fields inherited from class com.adobe.cq.testing.client.components.AbstractComponent

changeProperties, client, componentPath, DEFAULT_LOCATION, jsonNode, location, pagePath

Constructor Summary

Constructors

Constructor and Description
Text(ComponentClient client, String pagePath, String location, String nameHint) The constructor stores all the component path information like parentPage, name etc.

Method Summary

Modifier and Type	Method and Description
String	getResourceType() The resource type for the component, e.g.
void	setIsMultiValue(boolean isMultiValue) Defines if the form field is a multi value ( a '+' gets added next to the form field)
void	setIsReadOnly(boolean isReadOnly) If the input field should only show its value but not be editable
void	setStyleColRows(int cols, int rows) Sets number of columns and rows for the input area
void	setWidth(int width) set the width of the input area in pixels

Methods inherited from class com.adobe.cq.testing.client.components.foundation.form.AbstractFormFieldComponent

getCreateFormEntity, getElementName, setConstraint, setDefaultValue, setDescription, setElementName, setHideTitle, setStylingCss, setTitle, setUseConstraint

Methods inherited from class com.adobe.cq.testing.client.components.AbstractComponent

create, getClient, getComponentNode, getComponentPath, getFirstChild, getLocation, getName, getNext, getNextNodePath, getPagePath, getParentPath, getPrevious, getPreviousNodePath, getProperty, getPropertyAsString, getPropertyAsStringArray, reorder, save, setProperty, setProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RESOURCE_TYPE

public static final String RESOURCE_TYPE

See Also:

Constant Field Values

PROP_IS_MULTI_VALUE

public static final String PROP_IS_MULTI_VALUE

See Also:

Constant Field Values

PROP_IS_READ_ONLY

public static final String PROP_IS_READ_ONLY

See Also:

Constant Field Values

PROP_STYLE_COLS

public static final String PROP_STYLE_COLS

See Also:

Constant Field Values

PROP_STYLE_ROWS

public static final String PROP_STYLE_ROWS

See Also:

Constant Field Values

PROP_STYLE_WIDTH

public static final String PROP_STYLE_WIDTH

See Also:

Constant Field Values

Constructor Detail

Text

public Text(ComponentClient client,
            String pagePath,
            String location,
            String nameHint)

The constructor stores all the component path information like parentPage, name etc.

Parameters:

client - The ComponentClient that will be used for sending the requests.

pagePath - path to the page that will contain the component.

location - relative location to the parent node inside the page that will contain the component node.

nameHint - name to be used for the component node. Might get altered by the server if a naming conflict occurs. The AbstractComponent.getName() method will return the correct name after (order,int...) has been called.

Method Detail

getResourceType

public String getResourceType()

Description copied from class: AbstractComponent

The resource type for the component, e.g. foundation/components/text. this will be set in the sling:resourceType property of the node.

Specified by:

getResourceType in class AbstractComponent

Returns:

the resource type

setIsMultiValue

public void setIsMultiValue(boolean isMultiValue)

Defines if the form field is a multi value ( a '+' gets added next to the form field)

Parameters:

isMultiValue - true if the form field is multi valued, otherwise false

setIsReadOnly

public void setIsReadOnly(boolean isReadOnly)

If the input field should only show its value but not be editable

Parameters:

isReadOnly - true to only show the value

setStyleColRows

public void setStyleColRows(int cols,
                            int rows)

Sets number of columns and rows for the input area

Parameters:

cols - number of columns

rows - number of rows

setWidth

public void setWidth(int width)

set the width of the input area in pixels

Parameters:

width - width in pixels