org.opensingular.form.wicket.IWicketComponentMapper Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2016 Singular Studios (a.k.a Atom Tecnologia) - www.opensingular.com
 *
 * 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 org.opensingular.form.wicket;

import org.apache.commons.lang3.StringUtils;
import org.apache.wicket.Component;
import org.apache.wicket.markup.html.basic.Label;
import org.apache.wicket.model.IModel;
import org.opensingular.form.SInstance;
import org.opensingular.form.aspect.AspectRef;
import org.opensingular.form.type.basic.SPackageBasic;
import org.opensingular.form.wicket.behavior.DisabledClassBehavior;
import org.opensingular.form.wicket.mapper.SingularEventsHandlers;
import org.opensingular.form.wicket.model.AttributeModel;
import org.opensingular.lib.wicket.util.bootstrap.layout.BSControls;
import org.opensingular.lib.wicket.util.bootstrap.layout.BSLabel;
import org.opensingular.lib.wicket.util.util.WicketUtils;

import java.io.Serializable;

import static org.opensingular.form.wicket.mapper.SingularEventsHandlers.FUNCTION.ADD_TEXT_FIELD_HANDLERS;
import static org.opensingular.lib.wicket.util.util.Shortcuts.$b;

@FunctionalInterface
public interface IWicketComponentMapper extends Serializable {

    AspectRef ASPECT_WICKET_MAPPER = new AspectRef<>(
            IWicketComponentMapper.class, IWicketComponentMapperRegistry.class);

    HintKey HIDE_LABEL = () -> Boolean.FALSE;

    void buildView(WicketBuildContext ctx);

    default void addAjaxUpdate(WicketBuildContext ctx, Component component, IModel model, IAjaxUpdateListener listener) {
        component.setOutputMarkupId(true);
        adjustJSEvents(ctx, component);
        new AjaxUpdateListenersFactory().getBehaviorsForm(component, model, listener).forEach(component::add);
    }

    default void adjustJSEvents(Component comp) {
        comp.add(new SingularEventsHandlers(ADD_TEXT_FIELD_HANDLERS));
    }

    default void adjustJSEvents(WicketBuildContext ctx, Component comp) {
        adjustJSEvents(comp);
    }

    @FunctionalInterface
    interface HintKey extends Serializable {
        T getDefaultValue();

        default boolean isInheritable() {
            return false;
        }
    }

    HintKey NO_DECORATION = new HintKey() {
        @Override
        public Boolean getDefaultValue() {
            return Boolean.FALSE;
        }

        @Override
        public boolean isInheritable() {
            return true;
        }
    };

    /**
     * This hint makes fields that are disabled to
     * be shown as text only, instead of fields marked
     * as disabled.
     */
    HintKey DISABLED_AS_TEXT_ONLY = new HintKey() {
        @Override
        public Boolean getDefaultValue() {
            return Boolean.FALSE;
        }

        @Override
        public boolean isInheritable() {
            return true;
        }
    };

    /**
     * Method responsible for create and configurate the label used by the default's inputs by Singular form.
     *
     * @param ctx The WicketBuildCOntext, to know if contains the HIDE_LABEL configuration.
     * @return The Bootstrap label configured.
     */
    default BSLabel createLabel(WicketBuildContext ctx) {
        final AttributeModel labelModel = new AttributeModel<>(ctx.getModel(), SPackageBasic.ATR_LABEL);
        BSLabel label = new BSLabel("label", labelModel);
        label.add(DisabledClassBehavior.getInstance());
        label.setVisible(!ctx.getHint(NO_DECORATION));
        label.setEscapeModelStrings(!ctx.getCurrentInstance().asAtr().isEnabledHTMLInLabel());
        label.add($b.onConfigure(c -> {
            if (ctx.getHint(HIDE_LABEL) || StringUtils.isEmpty(labelModel.getObject())) {
                c.setVisible(false);
            }
        }));
        return label;
    }

    /**
     * Method responsible for create the subtitle of the input's form.
     *
     * @param formGroup The formGroup what will be added the subtitle.
     * @param subtitle  The subtitle text.
     */
    default void createSubTitle(BSControls formGroup, AttributeModel subtitle) {
        formGroup.newHelpBlock(subtitle);
    }


    /**
     * This LabelBar is use for creating the container of the label, including a Css Style.
     * The container will have the label and the Help icon if exists. SPackageBasic.ATR_HELP
     *
     * @param label The label for the input.
     * @return The container with the label, and a Css class.
     */
    default BSControls createLabelBar(Label label) {
        BSControls labelBar = new BSControls("labelBar")
                .appendLabel(label);
        labelBar.add(WicketUtils.$b.classAppender("labelBar"));
        return labelBar;
    }

}