sidepanelfactory.java

来自「Java生成PDF Java生成PDF Java生成PDF」· Java 代码 · 共 52 行

// $Id: SidePanelFactory.java,v 1.3 2007/05/21 15:02:59 mike Exp $

package org.faceless.pdf2.viewer2;

import org.faceless.pdf2.*;

/**
 * A type of ViewerFeature that creates {@link SidePanel} objects.
 * <p><i>This code is copyright the Big Faceless Organization. You're welcome to use, modify and distribute it in any form in your own projects, provided those projects continue to make use of the Big Faceless PDF library.</i></p>
 * @since 2.8
 */
public abstract class SidePanelFactory extends ViewerFeature
{
    private final String displayname;

    /**
     * Create a new SidePanelFactory.
     * @param name the official name of the feature
     * @param displayname the display name of the panel in the viewer
     */
    public SidePanelFactory(String name, String displayname) {
        super(name);
        this.displayname = displayname==null ? name : displayname;
    }

    /**
     * Get the name that the side panel should have in the viewer
     */
    public String getDisplayName() {
        return displayname;
    }

    public String toString() {
        return "SidePanelFactory:"+super.toString();
    }

    /**
     * Determines whether this side panel is required for this PDF.
     * By default this method returns true, but an example of where this
     * wouldn't apply is for the Bookmarks panel on a PDF with no
     * bookmarks.
     */
    public boolean isSidePanelRequired(PDF pdf) {
        return true;
    }

    /**
     * Create and return a new {@link SidePanel}.
     */
    public abstract SidePanel createSidePanel();
}