com.tcdng.unify.web.ui.widget.control.AssignmentBox Maven / Gradle / Ivy

/*
 * Copyright 2018-2023 The Code Department.
 * 
 * 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.tcdng.unify.web.ui.widget.control;

import java.util.ArrayList;
import java.util.List;

import com.tcdng.unify.core.UnifyException;
import com.tcdng.unify.core.annotation.Component;
import com.tcdng.unify.core.annotation.UplAttribute;
import com.tcdng.unify.core.annotation.UplAttributes;
import com.tcdng.unify.core.util.StringUtils;
import com.tcdng.unify.web.ui.widget.AbstractMultiControl;
import com.tcdng.unify.web.ui.widget.Control;

/**
 * Used for managing the assignment of items. Provides a view of available items
 * and already assigned items.
 * 
 * @author The Code Department
 * @since 1.0
 */
@Component("ui-assignmentbox")
@UplAttributes({ @UplAttribute(name = "filterList1", type = String.class),
        @UplAttribute(name = "filterList2", type = String.class),
        @UplAttribute(name = "assignList", type = String.class, mandatory = true),
        @UplAttribute(name = "unassignList", type = String.class, mandatory = true),
        @UplAttribute(name = "filterCaption1", type = String.class),
        @UplAttribute(name = "filterCaption2", type = String.class),
        @UplAttribute(name = "assignCaption", type = String.class, mandatory = true),
        @UplAttribute(name = "unassignCaption", type = String.class, mandatory = true),
        @UplAttribute(name = "assignListKey", type = String.class),
        @UplAttribute(name = "unassignListKey", type = String.class),
        @UplAttribute(name = "assignListDesc", type = String.class),
        @UplAttribute(name = "unassignListDesc", type = String.class),
        @UplAttribute(name = "multiSelectStyle", type = String.class),
        @UplAttribute(name = "listRule", type = String.class),
        @UplAttribute(name = "baseIdBinding", type = String.class),
        @UplAttribute(name = "allowAssignAll", type = boolean.class, defaultVal="true"),
        @UplAttribute(name = "showAssignedOnly", type = boolean.class) })
public class AssignmentBox extends AbstractMultiControl {

    private Control assignedSelCtrl;

    private Control unassignedSelCtrl;

    private Control filterCtrl1;

    private Control filterCtrl2;

    private Control assignCtrl;

    private Control assignAllCtrl;

    private Control unassignCtrl;

    private Control unassignAllCtrl;

    private String filterId1;

    private String filterId2;

    private List assignedSelList;

    private List unassignedSelList;

    private List assignedIdList;

    @SuppressWarnings("unchecked")
    @Override
    public void updateInternalState() throws UnifyException {
        List valueList = getValue(List.class, String.class);
        if (assignedIdList != valueList) {
            assignedIdList = valueList;
        }

        if (assignedIdList == null) {
            assignedIdList = new ArrayList();
        }

        if (assignedSelList != null) {
            for (String id : assignedSelList) {
                assignedIdList.remove(id);
            }

            assignedSelList = null;
        }

        if (unassignedSelList != null) {
            for (String id : unassignedSelList) {
                assignedIdList.add(id);
            }

            unassignedSelList = null;
        }

        setValue(assignedIdList);
    }

    public String getFilterCaption1() throws UnifyException {
        return getUplAttribute(String.class, "filterCaption1");
    }

    public String getFilterCaption2() throws UnifyException {
        return getUplAttribute(String.class, "filterCaption2");
    }

    public String getUnassignCaption() throws UnifyException {
        return getUplAttribute(String.class, "unassignCaption");
    }

    public String getAssignCaption() throws UnifyException {
        return getUplAttribute(String.class, "assignCaption");
    }

    public boolean isAllowAssignAll() throws UnifyException {
        return getUplAttribute(boolean.class, "allowAssignAll");
    }

    public boolean isShowAssignedOnly() throws UnifyException {
        return getUplAttribute(boolean.class, "showAssignedOnly");
    }

    public Control getFilterSel1() {
        return filterCtrl1;
    }

    public Control getFilterSel2() {
        return filterCtrl2;
    }

    public Control getAssignSel() {
        return assignedSelCtrl;
    }

    public Control getUnassignSel() {
        return unassignedSelCtrl;
    }

    public Control getAssignBtn() {
        return assignCtrl;
    }

    public Control getAssignAllBtn() {
        return assignAllCtrl;
    }

    public Control getUnassignBtn() {
        return unassignCtrl;
    }

    public Control getUnassignAllBtn() {
        return unassignAllCtrl;
    }

    public List getAssignedSelList() {
        return assignedSelList;
    }

    public void setAssignedSelList(List assignedSelList) {
        this.assignedSelList = assignedSelList;
    }

    public List getUnassignedSelList() {
        return unassignedSelList;
    }

    public void setUnassignedSelList(List unassignedSelList) {
        this.unassignedSelList = unassignedSelList;
    }

    public List getAssignedIdList() {
        return assignedIdList;
    }

    public void setAssignedIdList(List assignedIdList) {
        this.assignedIdList = assignedIdList;
    }

    public String getListRule() throws UnifyException {
        return getUplAttribute(String.class, "listRule");
    }

    public String getFilterId1() {
        return filterId1;
    }

    public void setFilterId1(String filterId1) {
        this.filterId1 = filterId1;
    }

    public String getFilterId2() {
        return filterId2;
    }

    public void setFilterId2(String filterId2) {
        this.filterId2 = filterId2;
    }

    public Long getAssignBaseId() throws UnifyException {
        String baseIdBinding = getUplAttribute(String.class, "baseIdBinding");
        if (!StringUtils.isBlank(baseIdBinding)) {
            return getValue(Long.class, baseIdBinding);
        }

        return null;
    }

    @Override
    protected void doOnPageConstruct() throws UnifyException {
        String filterList1 = getUplAttribute(String.class, "filterList1");
        if (StringUtils.isNotBlank(filterList1)) {
            filterCtrl1 = (Control) addInternalChildWidget("!ui-select styleClass:$e{abfselect} blankOption:$s{} list:"
                    + filterList1 + " binding:filterId1 popupAlways:true");
        }

        String filterList2 = getUplAttribute(String.class, "filterList2");
        if (StringUtils.isNotBlank(filterList2)) {
            filterCtrl2 = (Control) addInternalChildWidget("!ui-select styleClass:$e{abfselect} blankOption:$s{} list:"
                    + filterList2 + " listParams:$s{filterId1} binding:filterId2 popupAlways:true");
        }

        String msStyle = "";
        String multiSelectStyle = getUplAttribute(String.class, "multiSelectStyle");
        if (multiSelectStyle != null) {
            msStyle = "style:$s{" + multiSelectStyle + "}";
        }

        assignedSelCtrl = (Control) addInternalChildWidget(
                constructMultiSelect("assignList", "assignListKey", "assignListDesc", "assignedSelList", msStyle));
        unassignedSelCtrl = (Control) addInternalChildWidget(constructMultiSelect("unassignList", "unassignListKey",
                "unassignListDesc", "unassignedSelList", msStyle));
        assignCtrl = (Control) addInternalChildWidget(
                "!ui-button styleClass:$e{abbutton} caption:$m{button.assign} debounce:false");
        assignAllCtrl = (Control) addInternalChildWidget(
                "!ui-button styleClass:$e{abbutton} caption:$m{button.assignall} debounce:false");
        unassignCtrl = (Control) addInternalChildWidget(
                "!ui-button styleClass:$e{abbutton} caption:$m{button.unassign} debounce:false");
        unassignAllCtrl = (Control) addInternalChildWidget(
                "!ui-button styleClass:$e{abbutton} caption:$m{button.unassignall} debounce:false");
    }

    private String constructMultiSelect(String listAttr, String listKeyAttr, String listDescAttr, String binding,
            String msStyle) throws UnifyException {
        StringBuilder sb = new StringBuilder();
        sb.append("!ui-multiselect styleClass:$e{abmselect} ").append(msStyle).append(" list:")
                .append(getUplAttribute(String.class, listAttr));
        String listKey = getUplAttribute(String.class, listKeyAttr);
        if (StringUtils.isNotBlank(listKey)) {
            sb.append(" listKey:").append(listKey);
        }

        String listDesc = getUplAttribute(String.class, listDescAttr);
        if (StringUtils.isNotBlank(listDesc)) {
            sb.append(" listDescription:").append(listDesc);
        }

        sb.append(" listParams:$l{assignBaseId assignedIdList listRule filterId1 filterId2} binding:").append(binding);
        return sb.toString();
    }
}