com.foreach.across.modules.entity.EntityAttributeRegistrars Maven / Gradle / Ivy
/*
* Copyright 2014 the original author or authors
*
* 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.foreach.across.modules.entity;
import com.foreach.across.modules.entity.config.AttributeRegistrar;
import com.foreach.across.modules.entity.registry.EntityConfiguration;
import com.foreach.across.modules.entity.views.EntityViewFactory;
import com.foreach.across.modules.entity.views.menu.EntityAdminMenuAttributeRegistrar;
import com.foreach.across.modules.entity.views.menu.EntityAdminMenuEvent;
import com.foreach.across.modules.web.menu.PathBasedMenuBuilder;
import java.util.function.Consumer;
/**
* Contains common {@link com.foreach.across.modules.entity.config.AttributeRegistrar} returning functions
* for things like {@link EntityConfiguration}, {@link EntityViewFactory} etc.
*
* @author Arne Vandamme
* @see com.foreach.across.modules.entity.views.EntityViewFactoryAttributes
* @see com.foreach.across.modules.entity.views.menu.EntityAdminMenuAttributeRegistrar
* @since 3.0.0
*/
public interface EntityAttributeRegistrars
{
/**
* Register a default view menu item with the registered path.
*
* @param menuPath for the item
* @return view attribute registrar
*/
static AttributeRegistrar adminMenu( String menuPath ) {
return EntityAdminMenuAttributeRegistrar.adminMenu( menuPath );
}
/**
* Register a default view menu item with the registered path.
*
* @param menuPath for the item
* @param itemCustomizer for additional customization of the menu item
* @return view attribute registrar
*/
static AttributeRegistrar adminMenu( String menuPath, Consumer itemCustomizer ) {
return EntityAdminMenuAttributeRegistrar.adminMenu( menuPath, itemCustomizer );
}
/**
* Register a custom menu event consumer.
*
* @param menuEventConsumer for handling the menu
* @param entity type
* @return view attribute registrar
*/
static AttributeRegistrar adminMenu( Consumer> menuEventConsumer ) {
return EntityAdminMenuAttributeRegistrar.adminMenu( menuEventConsumer );
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy