com.citytechinc.cq.component.dialog

Class AbstractWidget

java.lang.Object

com.citytechinc.cq.component.xml.AbstractXmlElement

com.citytechinc.cq.component.dialog.AbstractDialogElement

com.citytechinc.cq.component.dialog.AbstractWidget

All Implemented Interfaces:

DialogElement, XmlElement

Direct Known Subclasses:

CheckBoxWidget, DateFieldWidget, DateTimeWidget, Dialog, DialogFieldSetWidget, HiddenWidget, Html5SmartFileWidget, Html5SmartImageWidget, MultiFieldWidget, NumberFieldWidget, PathFieldWidget, RichTextEditorWidget, SelectionWidget, SimpleWidget, SizeFieldWidget, TagInputFieldWidget, TextAreaWidget, TextFieldWidget

public abstract class AbstractWidget
extends AbstractDialogElement

Abstract class representing a Widget in the context of a Dialog. Concrete Widgets will extend this class and add any properties required by the extending Widget.

Field Summary

Fields inherited from class com.citytechinc.cq.component.xml.AbstractXmlElement

additionalProperties, containedElements, fieldName, nameSpace, primaryType

Constructor Summary

Constructors

Constructor and Description
AbstractWidget(DefaultWidgetParameters parameters) The constructor for the abstract Widget sets a number of properties common to all widget types.

Method Summary

Modifier and Type	Method and Description
String	getDefaultValue()
String	getFieldDescription()
String	getFieldLabel()
String	getName()
String	getXtype()
boolean	isAllowBlank()
boolean	isDisabled()
boolean	isHideLabel()
void	setName(String name)

Methods inherited from class com.citytechinc.cq.component.dialog.AbstractDialogElement

getRanking, setFieldName, setRanking

Methods inherited from class com.citytechinc.cq.component.xml.AbstractXmlElement

getAdditionalProperties, getContainedElements, getFieldName, getNameSpace, getPrimaryType

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.citytechinc.cq.component.xml.XmlElement

getAdditionalProperties, getContainedElements, getFieldName, getNameSpace, getPrimaryType

Constructor Detail

AbstractWidget

public AbstractWidget(DefaultWidgetParameters parameters)

The constructor for the abstract Widget sets a number of properties common to all widget types.

Parameters:

parameters -

Method Detail

getXtype

public String getXtype()

Returns:

xtype of the Widget

getName

public String getName()

Returns:

name of the Widget

getFieldLabel

public String getFieldLabel()

Returns:

field label to be applied to the rendered Widget

getFieldDescription

public String getFieldDescription()

Returns:

field description to be applied to the rendered Widget

isAllowBlank

public boolean isAllowBlank()

Returns:

Indication of whether the Widget may be left blank in an authoring Dialog

isDisabled

public boolean isDisabled()

Returns:

Indication of whether the Widget is disabled by default

isHideLabel

public boolean isHideLabel()

Returns:

Indication of whether the field label should be hidden for the Widget in the authoring Dialog

getDefaultValue

public String getDefaultValue()

Returns:

Default value of the Widget input

setName

public void setName(String name)

Parameters:

name -