com.citytechinc.cq.component.dialog.maker.WidgetMakerParameters 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.dialog.maker;
import javassist.ClassPool;
import javassist.CtMember;
import javassist.NotFoundException;
import com.citytechinc.cq.component.dialog.DialogFieldConfig;
import com.citytechinc.cq.component.dialog.exception.InvalidComponentFieldException;
import com.citytechinc.cq.component.dialog.widget.WidgetRegistry;
/**
* Base parameters which all Widgets use during their creation.
*
*/
public class WidgetMakerParameters {
private DialogFieldConfig dialogFieldConfig;
private Class containingClass;
private ClassLoader classLoader;
private ClassPool classPool;
private WidgetRegistry widgetRegistry;
private String xtype;
private boolean useDotSlashInName;
/**
*
* @param dialogField
* @param ctMember
* @param containingClass
* @param classLoader
* @param classPool
* @param widgetRegistry
* @param xtype
* @param useDotSlashInName
* @throws InvalidComponentFieldException
* @throws NotFoundException
*/
public WidgetMakerParameters(DialogFieldConfig dialogField, Class containingClass, ClassLoader classLoader,
ClassPool classPool, WidgetRegistry widgetRegistry, String xtype, boolean useDotSlashInName)
throws InvalidComponentFieldException, NotFoundException {
this.dialogFieldConfig = dialogField;
this.containingClass = containingClass;
this.classLoader = classLoader;
this.classPool = classPool;
this.widgetRegistry = widgetRegistry;
this.xtype = xtype;
this.useDotSlashInName = useDotSlashInName;
}
/**
*
* @return The DialogField annotation associated with the Widget
*/
public DialogFieldConfig getDialogFieldConfig() {
return dialogFieldConfig;
}
/**
*
* @param annotation
*/
public void setDialogFieldConfig(DialogFieldConfig dialogField) {
this.dialogFieldConfig = dialogField;
}
/**
*
* @return The CtMember representing the Widget
*/
public CtMember getCtMember() {
return dialogFieldConfig.getMember();
}
/**
*
* @return The Containing Class of the Widget
*/
public Class getContainingClass() {
return containingClass;
}
/**
*
* @param containingClass
*/
public void setContainingClass(Class containingClass) {
this.containingClass = containingClass;
}
/**
*
* @return The ClassLoader used by the maker
*/
public ClassLoader getClassLoader() {
return classLoader;
}
/**
*
* @param classLoader
*/
public void setClassLoader(ClassLoader classLoader) {
this.classLoader = classLoader;
}
/**
*
* @return The ClassPool used by the maker
*/
public ClassPool getClassPool() {
return classPool;
}
/**
*
* @param classPool
*/
public void setClassPool(ClassPool classPool) {
this.classPool = classPool;
}
/**
*
* @return The WidgetRegistry used by the maker for widget lookup
*/
public WidgetRegistry getWidgetRegistry() {
return widgetRegistry;
}
/**
*
* @param widgetRegistry
*/
public void setWidgetRegistry(WidgetRegistry widgetRegistry) {
this.widgetRegistry = widgetRegistry;
}
/**
*
* @return The Widget's xtype parameter
*/
public String getXtype() {
return xtype;
}
/**
*
* @param xtype
*/
public void setXtype(String xtype) {
this.xtype = xtype;
}
/**
*
* @return The useDotSlashInName parameter
*/
public boolean isUseDotSlashInName() {
return useDotSlashInName;
}
/**
*
* @param useDotSlashInName
*/
public void setUseDotSlashInName(boolean useDotSlashInName) {
this.useDotSlashInName = useDotSlashInName;
}
}