fr.techad.edc.popover.builder.ContextualComponentBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of edc-popover Show documentation

Java Popover to display a summary of the documentation published by edc

There is a newer version: 3.0.0

package fr.techad.edc.popover.builder;

/**
 * Builder to configure a contextual component.
 */
public interface ContextualComponentBuilder {

    /**
     * Define the keys for the component
     *
     * @param mainKey      the main key
     * @param subKey       the sub key
     * @param languageCode the language code
     * @return the builder
     */
    ContextualComponentBuilder setKeys(String mainKey, String subKey, String languageCode);

    /**
     * Define the label for the component
     *
     * @param label the label
     * @return the builder
     */
    ContextualComponentBuilder setLabel(String label);

    /**
     * Define the iconpath
     *
     * @param iconPath the icon path to set
     * @return the builder
     */
    ContextualComponentBuilder setIconPath(String iconPath);

    /**
     * Build the contextual component.
     *
     * @return the contextual component
     */
    T build();
}