com.holonplatform.vaadin7.components.BeanListing Maven / Gradle / Ivy

/*
 * Copyright 2000-2017 Holon TDCN.
 * 
 * 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.holonplatform.vaadin7.components;

import com.holonplatform.vaadin7.components.builders.ItemListingBuilder.GridItemListingBuilder;
import com.holonplatform.vaadin7.components.builders.ItemListingBuilder.TableItemListingBuilder;
import com.holonplatform.vaadin7.internal.components.builders.DefaultGridItemListingBuilder;
import com.holonplatform.vaadin7.internal.components.builders.DefaultTableItemListingBuilder;
import com.vaadin.ui.Grid;
import com.vaadin.ui.Table;

/**
 * An {@link ItemListing} component using a bean type as item type and the bean property names as property set.
 * 
 * @param  Bean type
 * 
 * @since 5.0.0
 */
public interface BeanListing extends ItemListing {

	/**
	 * Builder to create an {@link BeanListing} instance using a {@link Grid} as backing component.
	 * @param  Item data type
	 * @param itemType Item bean type
	 * @return Grid {@link BeanListing} builder
	 */
	static  GridItemListingBuilder builder(Class itemType) {
		return gridBuilder(itemType);
	}

	/**
	 * Builder to create an {@link BeanListing} instance using a {@link Grid} as backing component.
	 * @param  Item data type
	 * @param itemType Item bean type
	 * @return Grid {@link BeanListing} builder
	 */
	static  GridItemListingBuilder gridBuilder(Class itemType) {
		return new DefaultGridItemListingBuilder<>(itemType);
	}

	/**
	 * Builder to create an {@link BeanListing} instance using a {@link Table} as backing component.
	 * @param  Item data type
	 * @param itemType Item bean type
	 * @return Table {@link BeanListing} builder
	 */
	static  TableItemListingBuilder tableBuilder(Class itemType) {
		return new DefaultTableItemListingBuilder<>(itemType);
	}

}