ButtonConfigFactory.java

/*
 * Copyright (c) 2023-2026 LabKey Corporation
 *
 * 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.labkey.api.ldk.table;

import org.labkey.api.data.Container;
import org.labkey.api.data.TableInfo;
import org.labkey.api.data.UserDefinedButtonConfig;
import org.labkey.api.security.User;
import org.labkey.api.view.NavTree;
import org.labkey.api.view.template.ClientDependency;

import java.util.List;
import java.util.function.Supplier;

/**
 * Used to wire up customized buttons to standard LabKey data grids, like QueryWebPart will render.
 */
public interface ButtonConfigFactory
{
    UserDefinedButtonConfig createBtn(TableInfo ti);

    /** Generate a representation of the button (which might be a cascading menu) and what it should do when clicked */
    NavTree create(TableInfo ti);

    /**
     * @return true if the button is eligible to be added to the table's button bar. As this is invoked frequently,
     * it should be quick to return. If a detailed check is needed, use isVisible() which is invoked only at display
     * time
     */
    boolean isAvailable(TableInfo ti);

    /**
     * @return true if the button should be visible in the table's button bar. This will be invoked only when
     * actually constructing
     */
    boolean isVisible(TableInfo ti);

    List<Supplier<ClientDependency>> getClientDependencies(Container c, User u);
}