org.dbflute.cbean.paging.numberlink.PageNumberLinkSetupper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dbflute-runtime Show documentation

The runtime library of DBFlute

There is a newer version: 1.2.8

/*
 * Copyright 2014-2023 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 org.dbflute.cbean.paging.numberlink;

/**
 * The set-upper of page number link.
 *  * page.setPageRangeSize(5);
 * List<PageNumberLink> linkList = page.pageRange().buildPageNumberLinkList(new PageNumberLinkSetupper<PageNumberLink>() {
 *     public PageNumberLink setup(int pageNumberElement, boolean current) {
 *         String href = buildPagingHref(pageNumberElement); // for paging navigation links
 *         return new PageNumberLink().initialize(pageNumberElement, current, href);
 *     }
 * });
 * 
 * @param  The type of link.
 * @author jflute
 */
@FunctionalInterface
public interface PageNumberLinkSetupper {

    /**
     * Set up page number link.
     * @param pageNumberElement Page number element.
     * @param current Is current page?
     * @return Page number link. (NotNull)
     */
    LINK setup(int pageNumberElement, boolean current);
}