org.faceless.pdf2.viewer2

## Class SidePanelFactory

- java.lang.Object
- - org.faceless.pdf2.viewer2.ViewerFeature
  - - org.faceless.pdf2.viewer2.SidePanelFactory

- Direct Known Subclasses:
    EmbeddedFilePanel, OutlinePanel, SearchPanel, SignaturePanel, ThumbnailPanel

      public abstract class SidePanelFactory
      extends ViewerFeature

  A type of ViewerFeature that creates `SidePanel` objects.

  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.

  Since:
    2.8

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `SidePanelFactory(String name)` Create a new SidePanelFactory.

  - ### Method Summary

    All Methods Instance Methods Abstract Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `abstract SidePanel` | `createSidePanel()` Create and return a new `SidePanel`.
    `boolean` | `isSidePanelRequired(PDF pdf)` Determines whether this side panel is required for this PDF.
    `String` | `toString()`

    - ### Methods inherited from class org.faceless.pdf2.viewer2.ViewerFeature

      `getAllEnabledFeatures, getAllFeatures, getCustomJavaScript, getFeatureProperty, getFeatureURLProperty, getName, initialize, isEnabledByDefault, setFeatureName, teardown`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### SidePanelFactory

          public SidePanelFactory(String name)

      Create a new SidePanelFactory.
      Parameters:
        `name` - the official name of the feature

  - ### Method Detail

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `ViewerFeature`

    - #### isSidePanelRequired

          public boolean isSidePanelRequired(PDF pdf)

      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.

    - #### createSidePanel

          public abstract SidePanel createSidePanel()

      Create and return a new `SidePanel`.

Copyright © 2001-2015 Big Faceless Organization