org.dbflute.cbean.paging.numberlink.PageNumberLink 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-2021 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;

import java.io.Serializable;

/**
 * The basic DTO 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(pageNumber, current, href);
 *     }
 * });
 * 
 * @author jflute
 */
public class PageNumberLink implements Serializable {

    // ===================================================================================
    //                                                                          Definition
    //                                                                          ==========
    /** The serial version UID for object serialization. (Default) */
    private static final long serialVersionUID = 1L;

    // ===================================================================================
    //                                                                           Attribute
    //                                                                           =========
    /** The element of page number. */
    protected int _pageNumberElement;

    /** Is the page number for current page? */
    protected boolean _current;

    /** The 'href' string corresponding to the page number. */
    protected String _pageNumberLinkHref;

    // ===================================================================================
    //                                                                         Constructor
    //                                                                         ===========
    /**
     * Constructor. 

     * You can initialize attributes by initialize() after this creation.
     */
    public PageNumberLink() {
    }

    // ===================================================================================
    //                                                                         Initializer
    //                                                                         ===========
    /**
     * Initialize basic attributes.
     * @param pageNumberElement The element of page number.
     * @param current Is the page number for current page?
     * @param pageNumberLinkHref The 'href' string corresponding to the page number. (NullAllowed)
     * @return this. (NotNull)
     */
    public PageNumberLink initialize(int pageNumberElement, boolean current, String pageNumberLinkHref) {
        setPageNumberElement(pageNumberElement);
        setCurrent(current);
        setPageNumberLinkHref(pageNumberLinkHref);
        return this;
    }

    // ===================================================================================
    //                                                                      Basic Override
    //                                                                      ==============
    /**
     * @return The view string of all attribute values. (NotNull)
     */
    @Override
    public String toString() {
        final StringBuffer sb = new StringBuffer();
        sb.append("{");
        sb.append("pageNumberElement=").append(_pageNumberElement);
        sb.append(", pageNumberLinkHref=").append(_pageNumberLinkHref);
        sb.append(", current=").append(_current);
        sb.append("}");
        return sb.toString();
    }

    // ===================================================================================
    //                                                                            Accessor
    //                                                                            ========
    public int getPageNumberElement() {
        return _pageNumberElement;
    }

    public void setPageNumberElement(int pageNumberElement) {
        _pageNumberElement = pageNumberElement;
    }

    public boolean isCurrent() {
        return _current;
    }

    public void setCurrent(boolean current) {
        _current = current;
    }

    public String getPageNumberLinkHref() {
        return _pageNumberLinkHref;
    }

    public void setPageNumberLinkHref(String pageNumberLinkHref) {
        _pageNumberLinkHref = pageNumberLinkHref;
    }
}