com.citytechinc.cq.component.annotations.config.Widget Maven / Gradle / Ivy
/**
* Copyright 2017 ICF Olson
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.citytechinc.cq.component.annotations.config;
import java.lang.annotation.Annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import com.citytechinc.cq.component.dialog.maker.AbstractWidgetMaker;
/**
* Used to indicate that a Class represents a Dialog Widget and makes explicit
* the connection between the Widget, an annotation necessary to indicate that a
* field or method is to be populated by a Dialog Widget of this type, and the
* mechanism which will create the widget.
*/
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
public @interface Widget {
/**
*
* The stacked annotation which will be used to indicate that a field is to
* be populated by a Dialog Widget of this type. This would be the
* annotation stacked under the
* {@link com.citytechinc.cq.component.annotations.DialogField DialogField}
* annotation on a given Component field.
*
*
* The annotationClass list may be left empty in which case the Widget ties
* together an xtype and WidgetMaker directly. The annotationClass list may
* not contain more than one Annotation class.
*
*/
Class annotationClass();
/**
* The class responsible for making instances of the annotated Widget Class.
*/
Class makerClass();
/**
* The xtype which will be rendered to the Dialog for a field populated by a
* Dialog Widget of this type.
*/
String xtype();
/**
* Used in the rare cases where multiple annotations will be stacked under a
* {@link com.citytechinc.cq.component.annotations.DialogField DialogField}
* annotation. In such cases, ranking indicates which annotation will be
* used in looking up an appropriate Widget type and Maker for the field in
* question. A Widget with a higher ranking will take precedence over one
* with a lower ranking. In the case of equal ranking values behavior can
* not be guaranteed.
*/
int ranking() default -1;
/**
* Feature flag which can be configured in a POMs additionalFeatures configuration
* indicating the inclusion of this widget in the widget registry during dialog rendering.
* If left empty the widget will always be included.
*
*/
String featureFlag() default "";
}