xdev.ui.paging.Pageable Maven / Gradle / Ivy

Go to download
/*
 * XDEV Application Framework - XDEV Application Framework
 * Copyright © 2003 XDEV Software (https://xdev.software)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 */
package xdev.ui.paging;


/**
 * @author XDEV Software (HL)
 * @since 4.0
 */
public interface Pageable
{
	/**
	 * Turns the paging behavior on or off.
	 * 
	 * @param b
	 *            true if the paging should be controlled via the
	 *            {@link #getPageControl()}
	 * @see #isPagingEnabled()
	 */
	public void setPagingEnabled(boolean b);
	
	
	/**
	 * @return true if the paging behavior is on,
	 *         false otherwise
	 * @see #setPagingEnabled(boolean)
	 */
	public boolean isPagingEnabled();
	
	
	/**
	 * 
	 * @return the controller object to control the paging of the pageable
	 *         component
	 */
	public PageControl getPageControl();
}