atom.widget.AbstractPagingAdapter Maven / Gradle / Ivy
/*
* Copyright © 2015 Geeoz, and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* The Research Projects is dual-licensed under the GNU General Public
* License, version 2.0 (GPLv2) and the Geeoz Commercial License.
*
* Solely for non-commercial purposes. A purpose is non-commercial only if
* it is in no manner primarily intended for or directed toward commercial
* advantage or private monetary compensation.
*
* This Geeoz Software is supplied to you by Geeoz in consideration of your
* agreement to the following terms, and your use, installation, modification
* or redistribution of this Geeoz Software constitutes acceptance of these
* terms. If you do not agree with these terms, please do not use, install,
* modify or redistribute this Geeoz Software.
*
* Neither the name, trademarks, service marks or logos of Geeoz may be used
* to endorse or promote products derived from the Geeoz Software without
* specific prior written permission from Geeoz.
*
* The Geeoz Software is provided by Geeoz on an "AS IS" basis. GEEOZ MAKES NO
* WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
* WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE, REGARDING THE GEEOZ SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
* COMBINATION WITH YOUR PRODUCTS.
*
* IN NO EVENT SHALL GEEOZ BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
* AND/OR DISTRIBUTION OF THE GEEOZ SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER
* THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
* OTHERWISE, EVEN IF GEEOZ HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* A copy of the GNU General Public License is included in the distribution in
* the file LICENSE and at
*
* http://www.gnu.org/licenses/gpl-2.0.html
*
* If you are using the Research Projects for commercial purposes, we
* encourage you to visit
*
* http://products.geeoz.com/license
*
* for more details.
*
* This software or hardware and documentation may provide access to
* or information on content, products, and services from third parties.
* Geeoz and its affiliates are not responsible for and expressly disclaim
* all warranties of any kind with respect to third-party content, products,
* and services. Geeoz and its affiliates will not be responsible for any loss,
* costs, or damages incurred due to your access to or use of third-party
* content, products, or services. If a third-party content exists, the
* additional copyright notices and license terms applicable to portions of the
* software are set forth in the THIRD_PARTY_LICENSE_README file.
*
* Please contact Geeoz or visit www.geeoz.com if you need additional
* information or have any questions.
*/
package atom.widget;
import atom.content.Context;
import atom.view.EventListener;
import atom.view.EventType;
import atom.view.View;
import atom.view.ViewGroup;
/**
* Extended {@link ListAdapter} that is the bridge between a {@link ListView}
* and the data that backs the list. The ListView can display any data provided
* that it is wrapped in a ListAdapter. Also provides base implementation
* for pagination.
*
* @param an corresponded object type
* @author Serge Voloshyn
* @version 1.3 3/1/15
*/
@Deprecated
public abstract class AbstractPagingAdapter implements ListAdapter {
/**
* Number of rows that will be displayed within single page.
*/
private transient int rowsPerPage = Integer.MAX_VALUE;
/**
* Indicates current page index.
*/
private transient int currentPage = 0;
/**
* Pagination controls view group.
*/
private transient ViewGroup footerView = null;
/**
* Next page click listener.
*/
private transient PagingListener nextListener = null;
/**
* Previous page click listener.
*/
private transient PagingListener previousListener = null;
/**
* Item click listener.
*/
private transient OnItemClickListener listener = null;
/**
* Default empty constructor with protected access.
*/
protected AbstractPagingAdapter() {
super();
}
/**
* Returns a current page index.
*
* @return current page index
*/
protected final int getCurrentPage() {
return currentPage;
}
/**
* Sets current page index.
*
* @param page new current page index.
*/
private void setCurrentPage(final int page) {
currentPage = page;
}
/**
* Retrieve number of rows that must displayed within single page.
*
* @return number of rows that must displayed within single page
*/
protected final int getRowsPerPage() {
return rowsPerPage;
}
@Override
public final void setRowPerPage(final int count) {
rowsPerPage = count;
}
@Override
public final void setOnItemClickListener(
final OnItemClickListener aListener) {
listener = aListener;
}
/**
* Retrieve item click listener.
*
* @return an item click listener
*/
protected final OnItemClickListener getOnItemClickListener() {
return listener;
}
@Override
public final ViewGroup getFooterView() {
if (footerView == null) {
footerView = (ViewGroup) Context.inflate(
"layout/simple-pager.xml",
Thread.currentThread().getContextClassLoader());
nextListener = new PagingListener(this, true);
previousListener = new PagingListener(this, false);
footerView.findChildViewById("previous-btn").setEventListener(
EventType.CLICK, previousListener);
footerView.findChildViewById("next-btn").setEventListener(
EventType.CLICK, nextListener);
}
updatePagerControlsState();
return footerView;
}
/**
* Update control element styles.
*
* Possible behaviours:
*
* - if all rows can be displayed within single page, both Previous and
* Next navigation controls and their corresponding listeners will be
* disabled
* - If adapter is on first page, Previous navigation control
* and corresponding listener will be disabled, otherwise they will be
* enabled
* - If adapter is on last page, Next navigation control
* and corresponding listener will be disabled, otherwise they will be
* enabled
*
*/
private void updatePagerControlsState() {
if (footerView == null) {
return;
}
final View prevBtnLi = footerView.findChildViewById("previous-btn-li");
final View nextBtnLi = footerView.findChildViewById("next-btn-li");
final String prevStyle = prevBtnLi.getStyleName();
if (currentPage > 0) {
if (prevStyle.contains("disabled")) {
prevBtnLi.setStyleName(prevStyle.replace("disabled", ""));
}
if (previousListener != null) {
previousListener.setDisabled(false);
}
} else {
if (!prevStyle.contains("disabled")) {
prevBtnLi.addStyleName("disabled");
}
if (previousListener != null) {
previousListener.setDisabled(true);
}
}
final String nextStyle = nextBtnLi.getStyleName();
if (rowsPerPage != Integer.MAX_VALUE
&& getCount() > (rowsPerPage * currentPage + rowsPerPage)) {
if (nextStyle.contains("disabled")) {
nextBtnLi.setStyleName(nextStyle.replace("disabled", ""));
}
if (nextListener != null) {
nextListener.setDisabled(false);
}
} else {
if (!nextStyle.contains("disabled")) {
nextBtnLi.addStyleName("disabled");
}
if (nextListener != null) {
nextListener.setDisabled(true);
}
}
}
/**
* Navigation control event listener.
*/
private static final class PagingListener implements EventListener {
/**
* Corresponding adapter.
*/
private final AbstractPagingAdapter adapter;
/**
* Whether should open next page or previous.
*/
private final boolean forward;
/**
* Whether this listener is disabled.
*
* @see atom.widget.AbstractPagingAdapter#updatePagerControlsState()
*/
private boolean disabled = false;
/**
* Default constructor.
*
* @param theAdapter corresponding adapter
* @param isForward whether should open next page or previous
*/
private PagingListener(final AbstractPagingAdapter theAdapter,
final boolean isForward) {
adapter = theAdapter;
forward = isForward;
}
/**
* Sets disable state flag.
*
* @param isDisabled whether listener is disabled or not.
*/
public void setDisabled(final boolean isDisabled) {
disabled = isDisabled;
}
@Override
public void onEvent(final EventType event, final View view) {
if (disabled) {
return;
}
final int page;
if (forward) {
page = adapter.getCurrentPage() + 1;
} else {
page = adapter.getCurrentPage() - 1;
}
adapter.setCurrentPage(page);
adapter.updatePagerControlsState();
adapter.getBodyView();
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy