AbstractWidgetMaker (CQ Component Plugin 6.1.3 API)

java.lang.Object
- com.citytechinc.cq.component.dialog.maker.AbstractWidgetMaker<T>

All Implemented Interfaces:

WidgetMaker

Direct Known Subclasses:

CheckBoxWidgetMaker, DateFieldWidgetMaker, DateTimeWidgetMaker, DefaultWidgetMaker, DialogFieldSetWidgetMaker, HiddenWidgetMaker, Html5SmartFileWidgetMaker, Html5SmartImageWidgetMaker, MultifieldWidgetMaker, NumberFieldWidgetMaker, PathFieldWidgetMaker, RichTextEditorMaker, SelectionWidgetMaker, SizeFieldWidgetMaker, TagInputFieldWidgetMaker
```
public abstract class AbstractWidgetMaker<T extends WidgetParameters>
extends Object
implements WidgetMaker
```

Field Summary

Fields
Modifier and Type Field and Description

protected WidgetMakerParameters parameters

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

Constructor Summary

Constructors
Constructor and Description
`AbstractWidgetMaker(WidgetMakerParameters parameters)` Widget Makers will take, as input to their constructor, Widget parameters which they can later use as they make their intended Widget.

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)`
`javassist.CtClass`	`getCtType()`
`protected String`	`getDefaultValueForField()`
`protected boolean`	`getDisabledForField()`
`protected String`	`getFieldDescriptionForField()`
`protected String`	`getFieldLabelForField()`
`protected String`	`getFieldNameForField()`
`protected boolean`	`getHideLabelForField()`
`protected Boolean`	`getIsRequiredForField()`
`protected Listeners`	`getListeners()`
`protected String`	`getName()`
`protected String`	`getNameForField()` Determines and returns the name for the dialog field.
`Class<?>`	`getType()`
`boolean`	`hasAnnotation(Class<?> annotationClass)`
`protected boolean`	`isField()`
`protected boolean`	`isMethod()`
`DialogElement`	`make()`
`protected abstract DialogElement`	`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 WidgetMakerParameters parameters
```
- Constructor Detail
  - AbstractWidgetMaker
```
public AbstractWidgetMaker(WidgetMakerParameters parameters)
```
    Widget Makers will take, as input to their constructor, Widget parameters which they can later use as they make their intended Widget.
    
    Parameters:
    
    parameters -
- Method Detail
  - make
```
public final DialogElement make()
                         throws InvalidComponentFieldException,
                                javassist.NotFoundException,
                                ClassNotFoundException,
                                SecurityException,
                                javassist.CannotCompileException,
                                NoSuchFieldException,
                                InstantiationException,
                                IllegalAccessException,
                                IllegalArgumentException,
                                InvocationTargetException,
                                NoSuchMethodException
```
    Specified by:
    
    make in interface WidgetMaker
    
    Returns:
    
    A constructed DialogElement Widget
    
    Throws:
    
    InvalidComponentFieldException
    
    javassist.NotFoundException
    
    ClassNotFoundException
    
    SecurityException
    
    javassist.CannotCompileException
    
    NoSuchFieldException
    
    InstantiationException
    
    IllegalAccessException
    
    IllegalArgumentException
    
    InvocationTargetException
    
    NoSuchMethodException
  - make
```
protected abstract DialogElement make(T parameters)
                               throws InvalidComponentFieldException,
                                      javassist.NotFoundException,
                                      ClassNotFoundException,
                                      SecurityException,
                                      javassist.CannotCompileException,
                                      NoSuchFieldException,
                                      InstantiationException,
                                      IllegalAccessException,
                                      IllegalArgumentException,
                                      InvocationTargetException,
                                      NoSuchMethodException
```
    Throws:
    
    InvalidComponentFieldException
    
    javassist.NotFoundException
    
    ClassNotFoundException
    
    SecurityException
    
    javassist.CannotCompileException
    
    NoSuchFieldException
    
    InstantiationException
    
    IllegalAccessException
    
    IllegalArgumentException
    
    InvocationTargetException
    
    NoSuchMethodException
  - 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.
  - getIsRequiredForField
```
protected Boolean getIsRequiredForField()
```
    Returns:
    
    required property of the DialogField annotation.
  - 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.
  - getDefaultValueForField
```
protected String getDefaultValueForField()
```
    Returns:
    
    The defaultValue property of the DialogField annotation if one is provided, null otherwise.
  - getDisabledForField
```
protected boolean getDisabledForField()
```
  - getHideLabelForField
```
protected boolean getHideLabelForField()
```
    Returns:
    
    The hideLabel property of the DialogField annotation.
  - getListeners
```
protected Listeners getListeners()
```
    Returns:
    
    The Listeners object configured via the listeners property of the DialogField annotation or null if no such configuration is defined.
  - 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
```
    Parameters:
    
    annotationClass - The type of annotation to look for on the Widget element
    
    Returns:
    
    An Annotation of the type requested if one is associated with the field or method representing the Widget being made, null otherwise.
    
    Throws:
    
    ClassNotFoundException
  - hasAnnotation
```
public boolean hasAnnotation(Class<?> annotationClass)
```
    Parameters:
    
    annotationClass - The type of annotation to look for on the Widget element
    
    Returns:
    
    True if an annotation of the type specified is associated with the field or method representing the Widget being made, false otherwise.
  - 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

Class AbstractWidgetMaker<T extends WidgetParameters>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

parameters

Constructor Detail

AbstractWidgetMaker

Method Detail

make

make

getNameForField

getFieldNameForField

getFieldLabelForField

getFieldDescriptionForField

getIsRequiredForField

getAdditionalPropertiesForField

getDefaultValueForField

getDisabledForField

getHideLabelForField

getListeners

getName

isField

isMethod

getAnnotation

hasAnnotation

getCtType

getType