com.tcdng.unify.web.ui.widget.ListControl 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;

import java.util.List;
import java.util.Map;

import com.tcdng.unify.core.UnifyException;
import com.tcdng.unify.core.data.Listable;
import com.tcdng.unify.core.format.Formatter;

/**
 * List control interface.
 * 
 * @author The Code Department
 * @since 1.0
 */
public interface ListControl extends Control {

    /**
     * Gets list control information.
     * 
     * @param formatter
     *                  optional label formatter
     * @return a list control information object
     * @throws UnifyException
     *                        if an error occurs
     */
    ListControlInfo getListControlInfo(Formatter