AbstractTouchUIWidgetMaker (CQ Component Plugin 6.1.3 API)

java.lang.Object
- com.citytechinc.cq.component.touchuidialog.widget.maker.AbstractTouchUIWidgetMaker<T>

All Implemented Interfaces:

TouchUIWidgetMaker

Direct Known Subclasses:

AutoCompleteWidgetMaker, CheckboxWidgetMaker, DateFieldWidgetMaker, DateTimeWidgetMaker, DefaultTouchUIWidgetMaker, DialogFieldSetWidgetMaker, FileUploadWidgetMaker, HiddenWidgetMaker, HideDialogFieldWidgetMaker, MultiFieldWidgetMaker, NumberFieldWidgetMaker, PathFieldWidgetMaker, RadioGroupWidgetMaker, RichTextEditorWidgetMaker, SelectionFieldWidgetMaker, SizeFieldWidgetMaker, SmartImageWidgetMaker, SwitchWidgetMaker, TagFieldWidgetMaker, TagsPickerWidgetMaker, TextAreaWidgetMaker, TextFieldWidgetMaker
```
public abstract class AbstractTouchUIWidgetMaker<T extends TouchUIWidgetParameters>
extends Object
implements TouchUIWidgetMaker
```

Field Summary

Fields
Modifier and Type Field and Description

protected TouchUIWidgetMakerParameters parameters

Fields
Modifier and Type	Field and Description
`protected TouchUIWidgetMakerParameters`	`parameters`

Constructor Summary

Constructors
Constructor and Description

AbstractTouchUIWidgetMaker(TouchUIWidgetMakerParameters parameters)

Constructors
Constructor and Description
`AbstractTouchUIWidgetMaker(TouchUIWidgetMakerParameters parameters)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected Map<String,String>`	`getAdditionalPropertiesForField()`
`<E> E`	`getAnnotation(Class<E> annotationClass)`
`protected String`	`getCssClassForField()`
`javassist.CtClass`	`getCtType()`
`protected String`	`getDefaultValueForField()`
`protected boolean`	`getDisabledForField()`
`protected String`	`getFieldDescriptionForField()`
`protected String`	`getFieldLabelForField()`
`protected String`	`getFieldNameForField()`
`protected String`	`getName()`
`protected String`	`getNameForField()` Determines and returns the name for the dialog field.
`protected boolean`	`getRequiredForField()`
`protected String`	`getTitleForField()`
`Class<?>`	`getType()`
`protected String`	`getValueForField()`
`protected boolean`	`isField()`
`protected boolean`	`isMethod()`
`TouchUIDialogElement`	`make()`
`protected abstract TouchUIDialogElement`	`make(T parameters)`

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

- Field Detail
  - parameters
```
protected final TouchUIWidgetMakerParameters parameters
```
- Constructor Detail
  - AbstractTouchUIWidgetMaker
```
public AbstractTouchUIWidgetMaker(TouchUIWidgetMakerParameters parameters)
```
- Method Detail
  - make
```
public final TouchUIDialogElement make()
                                throws ClassNotFoundException,
                                       InvalidComponentFieldException,
                                       TouchUIDialogGenerationException,
                                       IllegalAccessException,
                                       InstantiationException
```
    Specified by:
    
    make in interface TouchUIWidgetMaker
    
    Throws:
    
    ClassNotFoundException
    
    InvalidComponentFieldException
    
    TouchUIDialogGenerationException
    
    IllegalAccessException
    
    InstantiationException
  - make
```
protected abstract TouchUIDialogElement make(T parameters)
                                      throws ClassNotFoundException,
                                             InvalidComponentFieldException,
                                             TouchUIDialogGenerationException,
                                             IllegalAccessException,
                                             InstantiationException
```
    Throws:
    
    ClassNotFoundException
    
    InvalidComponentFieldException
    
    TouchUIDialogGenerationException
    
    IllegalAccessException
    
    InstantiationException
  - getNameForField
```
protected String getNameForField()
```
    Determines and returns the name for the dialog field. The name is the relative path to where any authored input using the resultant widget will be housed in the content repository.
    
    When useDotSlashInName is true, the string './' will be prepended to the determined name.
    
    Returns:
    
    The name property of the DialogField annotation if one is provided, otherwise the result of the getName() method.
  - getFieldNameForField
```
protected String getFieldNameForField()
```
    Returns:
    
    The fieldName property of the DialogField annotation if one is provided, the result of the getName() method otherwise.
  - getFieldLabelForField
```
protected String getFieldLabelForField()
```
    Returns:
    
    The fieldLabel property of the DialogField annotation if one is provided, null otherwise.
  - getFieldDescriptionForField
```
protected String getFieldDescriptionForField()
```
    Returns:
    
    The fieldDescription property of the DialogField annotation if one is provided, null otherwise.
  - getRequiredForField
```
protected boolean getRequiredForField()
```
  - getDefaultValueForField
```
protected String getDefaultValueForField()
```
  - getValueForField
```
protected String getValueForField()
```
  - getTitleForField
```
protected String getTitleForField()
```
  - getDisabledForField
```
protected boolean getDisabledForField()
```
  - getCssClassForField
```
protected String getCssClassForField()
```
  - getName
```
protected String getName()
```
    Returns:
    
    When the widget is represented by a field in the Java class, this method will return the name of the field. When the widget is represented by a method in the Java Class, the string 'is' or 'get' is stripped from the method name if it starts with either of these strings, and then returns the resultant string.
  - isField
```
protected boolean isField()
```
    Returns:
    
    True if the Widget is represented by a field in the Component class, false otherwise.
  - isMethod
```
protected boolean isMethod()
```
    Returns:
    
    True if the Widget is represented by a method in the Component class, false otherwise.
  - getAnnotation
```
public <E> E getAnnotation(Class<E> annotationClass)
                    throws ClassNotFoundException
```
    Throws:
    
    ClassNotFoundException
  - getCtType
```
public javassist.CtClass getCtType()
                            throws javassist.NotFoundException,
                                   InvalidComponentFieldException
```
    Returns:
    
    THe CtType of the field or method representing the Widget
    
    Throws:
    
    javassist.NotFoundException
    
    InvalidComponentFieldException
  - getType
```
public Class<?> getType()
                 throws InvalidComponentFieldException
```
    Returns:
    
    The Class of the field or method representing the Widget
    
    Throws:
    
    InvalidComponentFieldException
  - getAdditionalPropertiesForField
```
protected Map<String,String> getAdditionalPropertiesForField()
```
    Returns:
    
    Name Value pairs represented by the additional properties tied to the DialogField annotation, or null if no such properties are defined.

Class AbstractTouchUIWidgetMaker<T extends TouchUIWidgetParameters>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

parameters

Constructor Detail

AbstractTouchUIWidgetMaker

Method Detail

make

make

getNameForField

getFieldNameForField

getFieldLabelForField

getFieldDescriptionForField

getRequiredForField

getDefaultValueForField

getValueForField

getTitleForField

getDisabledForField

getCssClassForField

getName

isField

isMethod

getAnnotation

getCtType

getType

getAdditionalPropertiesForField