com.citytechinc.cq.component.annotations.widgets.RichTextEditor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cq-component-annotations Show documentation
There is a newer version: 7.0.0
Show newest version
package com.citytechinc.cq.component.annotations.widgets;

import com.citytechinc.cq.component.annotations.widgets.rte.Edit;
import com.citytechinc.cq.component.annotations.widgets.rte.FindReplace;
import com.citytechinc.cq.component.annotations.widgets.rte.Format;
import com.citytechinc.cq.component.annotations.widgets.rte.Image;
import com.citytechinc.cq.component.annotations.widgets.rte.Justify;
import com.citytechinc.cq.component.annotations.widgets.rte.Keys;
import com.citytechinc.cq.component.annotations.widgets.rte.Links;
import com.citytechinc.cq.component.annotations.widgets.rte.Lists;
import com.citytechinc.cq.component.annotations.widgets.rte.MiscTools;
import com.citytechinc.cq.component.annotations.widgets.rte.ParaFormat;
import com.citytechinc.cq.component.annotations.widgets.rte.SpellCheck;
import com.citytechinc.cq.component.annotations.widgets.rte.Style;
import com.citytechinc.cq.component.annotations.widgets.rte.SubSuperscript;
import com.citytechinc.cq.component.annotations.widgets.rte.Table;
import com.citytechinc.cq.component.annotations.widgets.rte.UISettings;
import com.citytechinc.cq.component.annotations.widgets.rte.Undo;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Represents a Widget of type CQ.form.RichText in Classic UI
 * 
 * This widget is not supported in Touch UI and will render as a textarea
 */
@Retention(RetentionPolicy.CLASS)
@Target({ ElementType.FIELD, ElementType.METHOD })
public @interface RichTextEditor {

    /**
     * Edit RTE Plugin configuration. For more information on configuring this plugin see the RTE
     * configuration documentation.
     *
     * @return Edit[]
     */
    Edit[] edit() default {};

    /**
     * FindReplace RTE Plugin configuration. For more information on configuring this plugin see the
     * RTE configuration documentation.
     *
     * @return FindReplace[]
     */
    FindReplace[] findreplace() default {};

    /**
     * Format RTE Plugin configuration. For more information on configuring this plugin see the RTE
     * configuration documentation.
     *
     * @return Format[]
     */
    Format[] format() default {};

    /**
     * Image RTE Plugin configuration. For more information on configuring this plugin see the RTE
     * configuration documentation.
     *
     * @return Image[]
     */
    Image[] image() default {};

    /**
     * Keys RTE Plugin configuration. For more information on configuring this plugin see the RTE
     * configuration documentation.
     *
     * @return Keys[]
     */
    Keys[] keys() default {};

    /**
     * Justify RTE Plugin configuration. For more information on configuring this plugin see the RTE
     * configuration documentation.
     *
     * @return Justify[]
     */
    Justify[] justify() default {};

    /**
     * Links RTE Plugin configuration. For more information on configuring this plugin see the RTE
     * configuration documentation.
     *
     * @return Links[]
     */
    Links[] links() default {};

    /**
     * Lists RTE Plugin configuration. For more information on configuring this plugin see the RTE
     * configuration documentation.
     *
     * @return Lists
     */
    Lists[] lists() default {};

    /**
     * MiscTools RTE Plugin configuration. For more information on configuring this plugin see the RTE
     * configuration documentation.
     *
     * @return MiscTools[]
     */
    MiscTools[] misctools() default {};

    /**
     * ParaFormat RTE Plugin configuration. For more information on configuring this plugin see the
     * RTE configuration documentation.
     *
     * @return ParaFormat[]
     */
    ParaFormat[] paraformat() default {};

    /**
     * SpellCheck RTE Plugin configuration. For more information on configuring this plugin see the RTE
     * configuration documentation.
     *
     * @return SpellCheck[]
     */
    SpellCheck[] spellcheck() default {};

    /**
     * Styles RTE Plugin configuration. For more information on configuring this plugin see the RTE
     * configuration documentation.
     *
     * @return Styles[]
     */
    Style[] styles() default {};

    /**
     * SubSuperscript RTE Plugin configuration. For more information on configuring this plugin see the RTE
     * configuration documentation.
     *
     * @return SubSuperscript[]
     */
    SubSuperscript[] subsuperscript() default {};

    /**
     * Table RTE Plugin configuration. For more information on configuring this plugin see the RTE
     * configuration documentation.
     *
     * @return Table[]
     */
    Table[] table() default {};

    /**
     * Undo RTE Plugin configuration. For more information on configuring this plugin see the RTE
     * configuration documentation.
     *
     * @return Undo[]
     */
    Undo[] undo() default {};

    /**
     * For Touch-UI Only
     * 

     * UI Settings Node configuration plugin see