Class AlbumBean

java.lang.Object
se.datadosen.jalbum.AlbumBean
All Implemented Interfaces:
ImageObserver, Cloneable, AlbumEngine
public class AlbumBean extends Object implements ImageObserver, AlbumEngine, Cloneable
JavaBean for creating web based photo albums with thumbnail page and slide pages. Provides the actual album generation functionality of JAlbum. Method comments have only been added where the use isn't obvious.

  • Field Details

  • Constructor Details

    • AlbumBean

      public AlbumBean()

    • AlbumBean

      public AlbumBean(JAlbumContext context)

  • Method Details

    • getStopwatch

      public Stopwatch getStopwatch()
      Returns:
      Time for last album make
      Since:
      25

    • setOnMakeStarted

      public void setOnMakeStarted(Runnable onMakeStarted)

    • getAlbumHeight

      public int getAlbumHeight()

    • setAlbumHeight

      public void setAlbumHeight(int albumHeight)

    • getAlbumWidth

      public int getAlbumWidth()

    • setAlbumWidth

      public void setAlbumWidth(int albumWidth)

    • isMakeThumbs

      public boolean isMakeThumbs()
      Returns:
      true if engine is making thumbnail images

    • setMakeThumbs

      public void setMakeThumbs(boolean makeThumbs)
      Set whether thumbnail images should be made or not
      Parameters:
      makeThumbs -

    • isMakeImages

      public boolean isMakeImages()
      Returns:
      true if engine is making scaled images as well
      Since:
      33

    • setMakeImages

      public void setMakeImages(boolean makeImages)
      Set whether scaled images should be made or not
      Parameters:
      makeImages -
      Since:
      33

    • isIncludeOriginals

      public boolean isIncludeOriginals()
      Returns:
      true if original images (or links to them) is included
      Since:
      33

    • setIncludeOriginals

      public void setIncludeOriginals(boolean includeOriginals)
      Set whether original images (or links to them) should be included as well
      Parameters:
      includeOriginals -
      Since:
      33

    • isUseInternalLinking

      public boolean isUseInternalLinking()
      Whether to save album size by avoiding generating multiple copies of closeups and thumbnails by allowing the same object to be referenced from several folders
      Since:
      38

    • setUseInternalLinking

      public void setUseInternalLinking(boolean useInternalLinking)
      Set whether to save album size by avoiding generating multiple copies of closeups and thumbnails by allowing the same object to be referenced from several folders
      Parameters:
      useInternalLinking -
      Since:
      38

    • getThemeImageProcessor

      public ThemeImageProcessor getThemeImageProcessor()
      Returns:
      Currently installed theme image processor or null
      Since:
      15

    • setThemeImageProcessor

      public void setThemeImageProcessor(ThemeImageProcessor themeImageProcessor)
      Control whether jAlbum should generate folder specific theme images. Cleared at the start of each album build (before init). Skins wanting theme images generated can pass new ThemeImageProcessor(engine) as argument
      Since:
      15

    • getOutputFormat

      public OutputFormat getOutputFormat()
      Image format for generated typical images (not the variants)
      Returns:
      Since:
      24

    • setOutputFormat

      public void setOutputFormat(OutputFormat outputFormat)
      Set image format for generated typical images (not the variants)
      Parameters:
      outputFormat -
      Since:
      24

    • getJSONMaker

      public JSONMaker getJSONMaker()
      Returns:
      JSONMaker instance or null if JSON making is disabled
      Since:
      18.3

    • getCreator

      public String getCreator()

    • setCreator

      public void setCreator(String creator)

    • getRights

      public String getRights()

    • setRights

      public void setRights(String rights)

    • getRightsURL

      public String getRightsURL()

    • setRightsURL

      public void setRightsURL(String rightsURL)

    • isOverrideExistingCopyright

      public boolean isOverrideExistingCopyright()

    • setOverrideExistingCopyright

      public void setOverrideExistingCopyright(boolean overrideExistingCopyright)

    • getLicenseManager

      public LicenseManager getLicenseManager()

    • getPageNamer

      public PageNamer getPageNamer()
      Returns:
      the currently installed PageNamer

    • setPageNamer

      public void setPageNamer(PageNamer pageNamer)
      Allows skins with special naming requirements to control how index pages and slide pages are named
      Parameters:
      pageNamer -

    • getFileNamer

      public FileNamer getFileNamer()
      Returns:
      the currently installed FileNamer

    • setFileNamer

      public void setFileNamer(FileNamer fileNamer)
      Allows skins with special naming requirements to control how files are named
      Since:
      10.3

    • getDisplayVersion

      public static String getDisplayVersion()

    • getInternalVersion

      public static String getInternalVersion()

    • getSkinProperties

      public SkinProperties getSkinProperties()
      Since:
      8.7

    • getChainedObjects

      public ChainedObjects getChainedObjects()
      Returns:
      @since 12.2

    • getRawParam

      public net.jalbum.jlibraw.RAWImageReadParam getRawParam()
      Get default RAW image read parameters used for controlling RAW processing
      Returns:
      Since:
      13.1

    • setRawParam

      public void setRawParam(net.jalbum.jlibraw.RAWImageReadParam rawParam)
      Set default RAW image read parameters used for controlling RAW processing
      Since:
      13.1

    • unloadCurrentSkin

      public void unloadCurrentSkin() throws IOException
      Experimental. Don't call
      Throws:
      IOException

    • getScriptEnvironment

      public ScriptEnvironment getScriptEnvironment()

    • clone

      public AlbumBean clone()
      Make a shallow copy of this object Note: It is not guaranteed that all member variables are separate or copied, just simple properties
      Overrides:
      clone in class Object
      Returns:
      Since:
      8.4

    • setDirectory

      public void setDirectory(String newDirectory)
      Set image directory. Mandatory to call before calling makeAlbum() Fires directory PropertyChangeEvent since 8.4
      Specified by:
      setDirectory in interface AlbumEngine
      Parameters:
      newDirectory -

    • getDirectory

      public String getDirectory()
      Specified by:
      getDirectory in interface AlbumEngine
      Returns:

    • getCurrentProject

      public AlbumProject getCurrentProject()

    • setCurrentProject

      public void setCurrentProject(AlbumProject currentProject)

    • setThumbSize

      public void setThumbSize(String newThumbSize) throws ParameterException
      Throws:
      ParameterException

    • getThumbSize

      public String getThumbSize()

    • isProcessFolderThumbs

      public boolean isProcessFolderThumbs()

    • setProcessFolderThumbs

      public void setProcessFolderThumbs(boolean processFolderThumbs)

    • setFolderThumbSize

      public void setFolderThumbSize(String folderThumbSize) throws ParameterException
      Throws:
      ParameterException

    • getFolderThumbSize

      public String getFolderThumbSize()

    • setImageSize

      public void setImageSize(String newImageSize) throws ParameterException
      Throws:
      ParameterException

    • getImageSize

      public String getImageSize()

    • getImageVariants

      public String getImageVariants()
      Returns:
      Additional generated image sizes and types (JSON formatted)
      Since:
      24

    • setImageVariants

      public void setImageVariants(String imageVariants)
      Parameters:
      imageVariants - json string describing image variants
      Since:
      24

    • getThumbVariants

      public String getThumbVariants()
      Returns:
      Additional generated image sizes and types (JSON formatted)
      Since:
      24

    • setThumbVariants

      public void setThumbVariants(String thumbVariants)
      Parameters:
      thumbVariants - Additional generated image sizes and types (JSON formatted)
      Since:
      24

    • getThemeImageDim

      public Dimension getThemeImageDim()
      Get dimension of theme image
      Returns:
      Theme image dimension or null if no theme image used
      Since:
      15

    • setThemeImageDim

      public void setThemeImageDim(Dimension themeImageDim)
      Set dimension of theme image
      Parameters:
      themeImageDim - Dimension or null if no theme image to be used
      Since:
      15

    • setThemeImageSize

      public void setThemeImageSize(String themeImageSize)
      Parameters:
      themeImageSize -
      Since:
      16

    • getThemeImageSize

      public String getThemeImageSize()
      Returns:
      Since:
      16

    • getImageDim

      public Dimension getImageDim()
      Returns:
      Image bounds as a Dimension
      Since:
      13.8

    • getThumbDim

      public Dimension getThumbDim()
      Returns:
      Thumbnail bounds as a Dimension
      Since:
      13.8

    • setCols

      public void setCols(int newCols)

    • getCols

      public int getCols()

    • setQualityPercent

      public void setQualityPercent(int newQualityPercent)

    • getQualityPercent

      public int getQualityPercent()

    • getQualityPercentWebP

      public int getQualityPercentWebP()
      Since:
      24

    • setQualityPercentWebP

      public void setQualityPercentWebP(int qualityPercentWebP)
      Parameters:
      qualityPercentWebP -
      Since:
      24

    • isHiDPIThumbs

      public boolean isHiDPIThumbs()
      Tell whether thumbnails are generated for HiDPI screens (i.e. being delivered twice the size as their stated thumbWidth and thumbHeight dimensions)
      Returns:
      whether HiDPI thumbnails are used or not
      Since:
      13.7

    • setHiDPIThumbs

      public void setHiDPIThumbs(boolean hiDPI)
      Set whether thumbnails are generated for HiDPI screens (i.e. being delivered twice the size as their stated thumbWidth and thumbHeight dimensions)
      Since:
      13.7

    • getImageScale

      public int getImageScale()
      Returns:
      Number of pixels per dot (1/72") (1 for ordinary images, 2 for HiDPI images)
      Since:
      13.7

    • getScaleForStage

      public int getScaleForStage(int stage)

    • getSizeForStage

      public Dimension getSizeForStage(int stage)
      Parameters:
      stage -
      Returns:
      The bounding Dimension for this stage
      Since:
      26.3

    • getThumbScale

      public int getThumbScale()
      Returns:
      Number of pixels per dot (1/72") (1 for ordinary images, 2 for HiDPI images)
      Since:
      13.7

    • setSharpenPercent

      public void setSharpenPercent(int newSharpenPercent)

    • getSharpenPercent

      public int getSharpenPercent()

    • isDisableColorSubsampling

      public boolean isDisableColorSubsampling()

    • setDisableColorSubsampling

      public void setDisableColorSubsampling(boolean disableColorSubsampling)
      Disable chroma/color subsampling. Applies to images written with 90% or higher compression quality
      Parameters:
      disableColorSubsampling -
      Since:
      16.3

    • isHiDPIImages

      public boolean isHiDPIImages()
      Tell whether closeup images are generated for HiDPI screens (i.e. being delivered twice the size as their stated thumbWidth and thumbHeight dimensions)
      Returns:
      whether HiDPI closeup images are used or not
      Since:
      13.7

    • setHiDPIImages

      public void setHiDPIImages(boolean hiDPI)
      Set whether closeup images are generated for HiDPI screens (i.e. being delivered twice the size as their stated thumbWidth and thumbHeight dimensions)
      Since:
      13.7

    • useScaledImagesAsOriginals

      public void useScaledImagesAsOriginals(boolean use)
      Internal use only. Don't call

    • setClassicReaders

      public void setClassicReaders(boolean newClassicReaders)
      Use Sun's old, but faster image readers for JPEG, GIF and PNG file types instead of ImageIO readers

    • isClassicReaders

      public boolean isClassicReaders()

    • setUseThumbForFolderIcon

      public void setUseThumbForFolderIcon(boolean newUseThumbForFolderIcon)
      Replace standard folder icon with a thumbnail from one of the files in the image directory
      Since:
      v6.1

    • isUseThumbForFolderIcon

      public boolean isUseThumbForFolderIcon()

    • setCpuCores

      public void setCpuCores(int cpuCores)
      Machines with multiple CPUs can utilize this method to cut down processing time Values higher than number of available processors are ignored. Renamed from setNThreads in order to ignore previously set conservative setting in jAlbum preferences.

    • getCpuCores

      public int getCpuCores()
      Renamed from getNThreads in order to default to max number of cpu cores and ignore previously conservative settings store in jAlbum preferences now that our image scaling is far more memory conservative
      Returns:

    • setSlides

      public void setSlides(boolean newSlides)

    • isSlides

      public boolean isSlides()

    • setDateFormat

      public void setDateFormat(String newDateFormat)

    • getDateFormat

      public String getDateFormat()

    • getDateFormatAsObject

      public DateFormat getDateFormatAsObject()

    • getImageInfoFormatter

      public ImageInfoFormatter getImageInfoFormatter()

    • getImageBackgroundColor

      public Color getImageBackgroundColor()
      jAlbum will use the background color when generating JPEG images from translucent images
      Since:
      8.3.4

    • setImageBackgroundColor

      public void setImageBackgroundColor(Color backgroundColor)
      jAlbum will use the background color when generating JPEG images from translucent images
      Since:
      8.3.4

    • processTemplateFile

      public void processTemplateFile(File source, File dest) throws IOException, ElementException, ScriptException
      Replace variables and perform template parsing as a file is being copied. Use the variables that are currently visible for the interpreter.
      Throws:
      IOException
      ElementException
      ScriptException
      Since:
      4.7

    • processTemplateFile

      public void processTemplateFile(File source, Writer writer) throws IOException, ElementException, ScriptException
      Made public in v22.0.4
      Parameters:
      source -
      writer -
      Throws:
      IOException
      ElementException
      ScriptException

    • getASTCache

      public AlbumBean.ASTCache getASTCache()
      Internal use only
      Returns:
      Since:
      17.1

    • processTemplate

      public String processTemplate(String s) throws ElementException, ScriptException
      Replace variables and perform template parsing Use the variables that are currently visible for the interpreter.
      Throws:
      ElementException
      ScriptException
      Since:
      6.1

    • processSection

      public String processSection(Section sec, Scope vars) throws ElementException, ScriptException
      Replace variables and perform template parsing using the passed variables.
      Parameters:
      sec - Section to process
      vars - Variables to process
      Throws:
      ElementException
      ScriptException
      Since:
      14

    • processSection

      public String processSection(Section sec, Map<String,Object> vars) throws ElementException, ScriptException
      Throws:
      ElementException
      ScriptException

    • processTemplateFile

      public void processTemplateFile(File source, File dest, Map vars) throws IOException, ElementException, ScriptException
      Replace variables and perform template parsing as a file is being copied Warning: This method has side effects of affecting the variables available in the current scope. Try using the version that doesn't take a Map as parameter
      Throws:
      IOException
      ElementException
      ScriptException

    • listFiles

      @Deprecated public File[] listFiles(File dir, boolean includeDirs, File outputDir) throws IOException
      Deprecated.
      Use the new AlbumObject object model instead (currentObject, currentFolder and rootFolder variables). Doesn't support renamed files
      List valid albumfiles and subdirectories of a directory. The list is NO LONGER ordered according to the project settings
      Parameters:
      includeDirs - Include directories?
      outputDir - Output directory or null if not include directories
      Throws:
      IOException

    • processImage

      public void processImage(AlbumObject ao, File outputDir, Set<String> outputNames, Map<String,CachedFile> thumbsContents, Map<String,CachedFile> slidesContents, AlbumBeanEvent eventObject)

    • getJAlbumVersion

      public String getJAlbumVersion()
      For version handling project files
      Returns:
      Since:
      25

    • addGlobals

      public void addGlobals(Map vars, boolean fullPreparation)

    • registerVariables

      public void registerVariables(File file, File outputDir) throws IOException, ScriptException
      We store a Map of file->Map pairs where the Map contains metadata like imageWidth, imageHeight and EXIF data (if present)
      Throws:
      IOException
      ScriptException

    • processScript

      public void processScript(File f) throws IOException, ScriptException
      Process BeanShell or JavaScript files
      Throws:
      IOException
      ScriptException

    • processScript

      public void processScript(File f, Bindings vars) throws IOException, ScriptException
      Process BeanShell or JavaScript files
      Throws:
      IOException
      ScriptException

    • processBeanShellFile

      @Deprecated public void processBeanShellFile(File f) throws ElementException, IOException
      Deprecated.
      Use processScript(File) instead
      Throws:
      ElementException
      IOException

    • countFiles

      @Deprecated public int countFiles(File dir) throws IOException
      Deprecated.
      Use JAlbumUtilities.countCategories instead for speed (less disk access) and flexibility
      Recursively figure out how many files to process in total v3.5 made public as a convenience
      Throws:
      IOException

    • init

      public void init() throws IOException, OperationAbortedException, ScriptException
      Throws:
      IOException
      OperationAbortedException
      ScriptException

    • isDirty

      public boolean isDirty()
      Tell if settings have changed since last album build
      Returns:
      Since:
      v12

    • makeAlbum

      public MakeResult makeAlbum() throws IllegalArgumentException, IOException, OperationAbortedException, ElementException, ScriptException
      Generate a web album. Before calling makeAlbum() you must always call setDirectory() and setOutputDirectory() to set an output
      Specified by:
      makeAlbum in interface AlbumEngine
      Returns:
      Throws:
      IOException
      ElementException
      IllegalArgumentException
      OperationAbortedException
      ScriptException

    • smartMakeAlbum

      public MakeResult smartMakeAlbum() throws IllegalArgumentException, IOException, OperationAbortedException, ElementException, ScriptException
      Make album but let jAlbum decide whether to make all or changes
      Specified by:
      smartMakeAlbum in interface AlbumEngine
      Returns:
      Throws:
      IOException
      ElementException
      IllegalArgumentException
      OperationAbortedException
      ScriptException

    • isMakingAlbum

      public boolean isMakingAlbum()
      Returns:
      Since:
      v12

    • imageUpdate

      public boolean imageUpdate(Image img, int infoflags, int x, int y, int width, int height)
      Ignore. Will be moved out of AlbumBean Implements ImageObserver
      Specified by:
      imageUpdate in interface ImageObserver

    • getWidgetInjectionCode

      public String getWidgetInjectionCode(String pageType, String rootPath)
      Parameters:
      pageType -
      rootPath -
      Returns:
      Since:
      jAlbum 17.1

    • getTargetThumbName

      public String getTargetThumbName(File file)
      Figure out what should be the final file name for thumbnails images. Unless forced, maps most file types to jpg but png and gif to png
      Parameters:
      file -
      Returns:
      Since:
      18.3

    • getTargetThumbName

      public String getTargetThumbName(File file, String defExt)
      Parameters:
      file -
      defExt -
      Returns:
      Since:
      23.3

    • getTargetName

      public String getTargetName(File file)
      Figure out what should be the final file name for closeup images. Unless forced, maps most file types to jpg but png and gif to png
      Parameters:
      file -
      Returns:

    • getScaledDim

      public static Dimension getScaledDim(Dimension dim, double scale)

    • removeAlbumBeanListener

      public void removeAlbumBeanListener(AlbumBeanListener listener)
      Specified by:
      removeAlbumBeanListener in interface AlbumEngine

    • removeAllAlbumBeanListeners

      public void removeAllAlbumBeanListeners()
      Since:
      25 For handover to background processing

    • addAlbumBeanListener

      public void addAlbumBeanListener(AlbumBeanListener listener)
      Specified by:
      addAlbumBeanListener in interface AlbumEngine

    • addPropertyChangeListener

      public void addPropertyChangeListener(PropertyChangeListener listener)

    • removePropertyChangeListener

      public void removePropertyChangeListener(PropertyChangeListener listener)
      Removes a PropertyChangeListener from the listener list. This method should be used to remove PropertyChangeListeners that were registered for all bound properties of this class.

      If listener is null, no exception is thrown and no action is performed.

      Parameters:
      listener - the PropertyChangeListener to be removed
      See Also:

    • addPropertyChangeListener

      public void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)

    • firePropertyChange

      protected void firePropertyChange(String propertyName, Object oldValue, Object newValue)
      Support for reporting bound property changes for Object properties. This method can be called when a bound property has changed and it will send the appropriate PropertyChangeEvent to any registered PropertyChangeListeners.
      Parameters:
      propertyName - the property whose value has changed
      oldValue - the property's previous value
      newValue - the property's new value

    • addFilter

      public void addFilter(JAFilter filter)
      Add an image filter to the image process chain so it affects both closeups and thumbnails

    • filterIterator

      public Iterator<JAFilter> filterIterator(int stage)

    • addFilter

      public boolean addFilter(JAFilter filter, int stage)
      Add an image filter to the image process chain at the specified stage

    • removeFilter

      public boolean removeFilter(JAFilter filter, int stage)
      Remove an image filter from the image process chain at the specified stage

    • removeAllFilters

      public void removeAllFilters()
      Remove all image filters from the image process chain

    • fireStatus

      public void fireStatus(String message)
      Fire status messages during album build
      Parameters:
      message -
      Since:
      27

    • fireWarning

      public void fireWarning(String message)
      Fire warning messages during album build
      Parameters:
      message -
      Since:
      30.3

    • fireRequestConfirmation

      public void fireRequestConfirmation(String message)

    • fireFolderProcessingStarted

      protected void fireFolderProcessingStarted(AlbumObject folder)

    • fireFolderProcessingFinished

      protected void fireFolderProcessingFinished(AlbumObject folder)

    • fireVideoProcessingProgress

      protected void fireVideoProcessingProgress(AlbumBeanEvent e, float progress)

    • fireImageProcessingStarted

      protected void fireImageProcessingStarted(AlbumBeanEvent e)

    • fireImageProcessingFinished

      protected void fireImageProcessingFinished(AlbumBeanEvent e)

    • fireErrorOccured

      protected void fireErrorOccured(Throwable t, AlbumObject ao)

    • fireAlbumMakingStarted

      protected void fireAlbumMakingStarted(boolean changes)

    • fireAlbumMakingDone

      protected void fireAlbumMakingDone(boolean success)

    • setSubdirs

      public void setSubdirs(boolean newSubdirs)

    • isSubdirs

      public boolean isSubdirs()

    • setAppendImages

      public void setAppendImages(boolean newAppendImages)
      Control if all image files are to be rescaled or only new files. Setting appendImages to true corresponds to "Make changes" Setting appendImages to false corresponds to "Make all" button.
      Specified by:
      setAppendImages in interface AlbumEngine
      Parameters:
      newAppendImages -

    • isAppendImages

      public boolean isAppendImages()
      Specified by:
      isAppendImages in interface AlbumEngine

    • setUpdatedDirsOnly

      public void setUpdatedDirsOnly(boolean newUpdatedDirsOnly)

    • isUpdatedDirsOnly

      public boolean isUpdatedDirsOnly()

    • setExcludeByDefault

      public void setExcludeByDefault(boolean newExcludeByDefault)
      Automatically exclude images recently added to the image directory
      Since:
      6.3

    • isExcludeByDefault

      public boolean isExcludeByDefault()

    • setKeepMetaData

      public void setKeepMetaData(boolean newKeepMetaData)
      Keep camera metadata in generated files
      Since:
      6.5

    • isKeepMetaData

      public boolean isKeepMetaData()

    • setKeepXmpData

      public void setKeepXmpData(boolean newKeepXmpData)
      Keep xmp metadata in generated files
      Since:
      10.8

    • isKeepXmpData

      public boolean isKeepXmpData()

    • getHomepageAddress

      public String getHomepageAddress()
      Since:
      10.8

    • setHomepageAddress

      public void setHomepageAddress(String homepageAddress)
      Since:
      10.8

    • getHomepageLinkText

      public String getHomepageLinkText()
      Since:
      10.8

    • setHomepageLinkText

      public void setHomepageLinkText(String homepageLinkText)
      Since:
      10.8

    • setStyle

      public void setStyle(String newStyle)
      Specified by:
      setStyle in interface AlbumEngine

    • getStyle

      public String getStyle()
      Specified by:
      getStyle in interface AlbumEngine

    • setIndexPageName

      public void setIndexPageName(String newIndexPageName)

    • getIndexPageName

      public String getIndexPageName()

    • isUrlEncode

      public boolean isUrlEncode()

    • setUrlEncode

      @Deprecated public void setUrlEncode(boolean b)
      Deprecated.
      Ignored from v17.2. URL encoding is now always on
      Parameters:
      b -

    • isRemoveDiacritics

      public boolean isRemoveDiacritics()
      Returns:
      Whether to have diacritics stripped from generated file names

    • setRemoveDiacritics

      public void setRemoveDiacritics(boolean removeDiacritics)
      Whether to have diacritics stripped from generated file names
      Parameters:
      removeDiacritics -

    • setImageOrdering

      public void setImageOrdering(String newImageOrdering)
      Set image ordering to one of the ORDER_ string constants defined in this class Will cancel any custom image ordering set by the setCustomImageOrdering call

    • getImageOrdering

      public String getImageOrdering()

    • setCustomImageOrdering

      public void setCustomImageOrdering(Comparator fileComparator)
      Select custom image/file ordering by installing a custom Comparator object. It is recommended that this method is called from the init.bsh file of a skin as the JAlbum user interface automatically resets this setting at the start of each album generation, before calling init.bsh. The resetting is done when the ordinary setImageOrdering method is called as the engine is synchronized with the UI.
      Parameters:
      fileComparator - Comparator object that is passed two File objects

    • getCustomImageOrdering

      public Comparator getCustomImageOrdering()

    • setMediaRSS

      public void setMediaRSS(boolean newMediaRSS)
      Add media RSS support to published albums
      Parameters:
      newMediaRSS - boolean

    • isMediaRSS

      public boolean isMediaRSS()

    • isGenerateJSON

      public boolean isGenerateJSON()
      Since:
      15.4 Tell whether JSON formatted metadata should be added to album

    • setGenerateJSON

      public void setGenerateJSON(boolean generateJSON)
      Tell whether JSON formatted metadata should be added to album
      Parameters:
      generateJSON -
      Since:
      15.4

    • getNotes

      public String getNotes()
      Returns:
      Project notes (notes to user of project. Not shown in album)
      Since:
      16

    • setNotes

      public void setNotes(String notes)
      Set pProject notes (notes to user of project. Not shown in album)
      Parameters:
      notes -
      Since:
      16

    • isNotifyNotes

      public boolean isNotifyNotes()

    • setNotifyNotes

      public void setNotifyNotes(boolean notifyNotes)

    • setWidgetInjection

      public void setWidgetInjection(boolean newWidgetInjection)
      Include widget injection to published albums
      Parameters:
      newWidgetInjection -

    • isWidgetInjection

      public boolean isWidgetInjection()

    • setExcludeBacklinks

      public void setExcludeBacklinks(boolean newExcludeBacklinks)
      Since:
      8.7

    • isExcludeBacklinks

      public boolean isExcludeBacklinks()

    • getUserName

      public String getUserName()

    • setUserName

      public void setUserName(String userName)

    • setMetaData

      public void setMetaData(boolean newMetaData)

    • isMetaData

      public boolean isMetaData()

    • setOutputDirectory

      public void setOutputDirectory(String newOutputDirectory)
      Specified by:
      setOutputDirectory in interface AlbumEngine

    • getOutputDirectory

      public String getOutputDirectory()
      Specified by:
      getOutputDirectory in interface AlbumEngine

    • getInterpretedOutputDirectory

      @Deprecated public File getInterpretedOutputDirectory()
      Deprecated.

    • getOutputDir

      public File getOutputDir()

    • setAlbumAddress

      public void setAlbumAddress(String albumAddress)

    • getAlbumAddress

      public String getAlbumAddress()

    • setRows

      public void setRows(int newRows)

    • getRows

      public int getRows()

    • setLimit

      public void setLimit(int limit)
      Limit number of album objects that are to be processed 0 = unlimited Use of this method by 3:rd party developers is discouraged
      Specified by:
      setLimit in interface AlbumEngine
      Since:
      8.3

    • getLimit

      public int getLimit()

    • setImageLinking

      @Deprecated public void setImageLinking(String newImageLinking)
      Deprecated.
      since v33. Use setMakeCloseups and setIncludeOriginals Will be called for older projects
      Set image linking to one of the LINK_ string constants defined in this class

    • getImageLinking

      @Deprecated public String getImageLinking()
      Deprecated.
      since v33. Use isMakeCloseups and isIncludeOriginals
      Returns:

    • setCopyOriginals

      public void setCopyOriginals(boolean newCopyOriginals)

    • isCopyOriginals

      public boolean isCopyOriginals()

    • getWebPassword

      public String getWebPassword()
      Upload privacy related

    • setWebPassword

      public void setWebPassword(String webPassword)
      Upload privacy related

    • isVisibleOnProfilePage

      public boolean isVisibleOnProfilePage()
      Upload privacy related

    • setVisibleOnProfilePage

      public void setVisibleOnProfilePage(boolean visibleOnProfilePage)
      Upload privacy related

    • setSkin

      public void setSkin(String newSkin)
      Specified by:
      setSkin in interface AlbumEngine

    • getSkin

      public String getSkin()
      Specified by:
      getSkin in interface AlbumEngine
      Returns:
      Currently active skin

    • getLastSkin

      public String getLastSkin()
      Returns:
      Last active skin
      Since:
      24

    • setPageExtension

      public void setPageExtension(String newPageExtension)

    • getPageExtension

      public String getPageExtension()

    • getResourceDirectory

      public String getResourceDirectory()
      JAlbum 4.5 additions

    • getThumbnailDirectory

      public String getThumbnailDirectory()

    • getCloseupDirectory

      public String getCloseupDirectory()

    • getSlideDirectory

      public String getSlideDirectory()

    • getThumbnailPrefix

      public String getThumbnailPrefix()

    • getCloseupPrefix

      public String getCloseupPrefix()

    • isReadJAlbumMetaData

      public boolean isReadJAlbumMetaData()

    • setReadJAlbumMetaData

      public void setReadJAlbumMetaData(boolean readJAlbumMetaData)

    • setReadXmp

      public void setReadXmp(boolean readXmp)
      When reading comments, give priority to XMP metadata over other metadata sources
      Parameters:
      readXmp -
      Since:
      10

    • isReadXmp

      public boolean isReadXmp()

    • setJpegComment

      public void setJpegComment(boolean newjpegComment)

    • isJpegComment

      public boolean isJpegComment()

    • setIptcCaption

      public void setIptcCaption(boolean newiptcCaption)

    • isIptcCaption

      public boolean isIptcCaption()

    • setExifUserComment

      public void setExifUserComment(boolean newexifUserComment)

    • isExifUserComment

      public boolean isExifUserComment()

    • getTitleSource

      public TitleSource getTitleSource()
      Since:
      9.6

    • setTitleSource

      public void setTitleSource(TitleSource titleSource)
      Since:
      9.6

    • setHighQualityThumbs

      public void setHighQualityThumbs(boolean newhighQualityThumbs)
      Control whether to force smooth scaling for thumbnails or rely on the general scaling quality setting
      Parameters:
      newhighQualityThumbs -

    • isHighQualityThumbs

      public boolean isHighQualityThumbs()

    • isForceProcessing

      public boolean isForceProcessing()
      Force image processing even if source image is smaller than destination and no filters are applied
      Since:
      17.1

    • setForceProcessing

      public void setForceProcessing(boolean forceProcessing)
      Force image processing even if source image is smaller than destination and no filters are applied
      Parameters:
      forceProcessing -
      Since:
      17.1

    • isForceVideoProcessing

      public boolean isForceVideoProcessing()
      Force video processing too if make mode is All
      Returns:
      Since:
      37

    • setForceVideoProcessing

      public void setForceVideoProcessing(boolean forceVideoProcessing)
      Force video processing too if make mode is All
      Since:
      37

    • setForceJPEGWriting

      @Deprecated public void setForceJPEGWriting(boolean force)
      Deprecated.
      Ensure that images and thumbnails are always written as JPEGs (never PNG) Use setForceThumbs and setForceImages. Only here for backwards compatibility
      Parameters:
      force -
      Since:
      10.5

    • isForceJPEGThumbs

      public boolean isForceJPEGThumbs()
      Returns:
      true if thumbnails are forced to JPEG format
      Since:
      18.3

    • setForceJPEGThumbs

      public void setForceJPEGThumbs(boolean forceJPEGThumbs)
      Force thumbnails to JPEG format
      Parameters:
      forceJPEGThumbs -
      Since:
      18.3

    • isForceJPEGImages

      public boolean isForceJPEGImages()
      Returns:
      true if closeup images are forced to JPEG format
      Since:
      18.3

    • setForceJPEGImages

      public void setForceJPEGImages(boolean forceJPEGImages)
      Force closeup images to JPEG format
      Parameters:
      forceJPEGImages -

    • isSuperimposeFilmIcon

      public boolean isSuperimposeFilmIcon()
      Since:
      jAlbum 8.12

    • setSuperimposeFilmIcon

      public void setSuperimposeFilmIcon(boolean superimposeFilmIcon)
      Tell if to superimpose a film icon onto the thumbnails of movie files
      Since:
      jAlbum 8.12

    • setExifImageDescription

      public void setExifImageDescription(boolean newexifImageDescription)

    • isExifImageDescription

      public boolean isExifImageDescription()

    • setIncludeDirectories

      public void setIncludeDirectories(boolean newIncludeDirectories)

    • isIncludeDirectories

      public boolean isIncludeDirectories()

    • setUserVariables

      public void setUserVariables(Map newUserVariables)
      Specified by:
      setUserVariables in interface AlbumEngine

    • getVideoProcessor

      public VideoProcessor getVideoProcessor()

    • getVideoParameters

      public Parameters getVideoParameters()

    • setVideoParameters

      public void setVideoParameters(Parameters videoParameters)

    • isUseCustomVideoSettings

      public boolean isUseCustomVideoSettings()

    • setUseCustomVideoSettings

      public void setUseCustomVideoSettings(boolean useCustomVideoSettings)

    • getVideoQuality

      public int getVideoQuality()

    • setVideoQuality

      public void setVideoQuality(int videoQuality)

    • getVideoResolution

      public VideoResolution getVideoResolution()

    • setVideoResolution

      public void setVideoResolution(VideoResolution videoResolution)

    • setSkinVariables

      public void setSkinVariables(Map newSkinVariables)
      The new way of passing variables from skin user interfaces to the AlbumBean (Previously the user variables mechanism was used which bloated the user variables)
      Specified by:
      setSkinVariables in interface AlbumEngine
      Since:
      5.2

    • setProperties

      public void setProperties(Properties props)
      Convenience method that calls the relevant setter methods on this bean depending on the passed properties. Skin and user variables, prefixed with skin. and user. will be installed as skin- and user variables
      Specified by:
      setProperties in interface AlbumEngine
      Since:
      8.4

    • getUserVariables

      public Map getUserVariables()
      Specified by:
      getUserVariables in interface AlbumEngine

    • getSkinVariables

      public Map getSkinVariables()
      Specified by:
      getSkinVariables in interface AlbumEngine

    • setRemoteDirectory

      public void setRemoteDirectory(String newRemoteDirectory)
      Might be moved out of AlbumBean

    • getRemoteDirectory

      public String getRemoteDirectory()
      Might be moved out of AlbumBean

    • setAccountProfileName

      public void setAccountProfileName(String newAccountProfileName)

    • getAccountProfileName

      public String getAccountProfileName()

    • setReverseOrder

      public void setReverseOrder(boolean newReverseOrder)

    • isReverseOrder

      public boolean isReverseOrder()

    • setTextEncoding

      public void setTextEncoding(String newTextEncoding)

    • getTextEncoding

      public String getTextEncoding()

    • setWriteUTF8

      public void setWriteUTF8(boolean newWriteUTF8)

    • isWriteUTF8

      public boolean isWriteUTF8()

    • setDirectoriesFirst

      public void setDirectoriesFirst(boolean newDirectoriesFirst)

    • isDirectoriesFirst

      public boolean isDirectoriesFirst()

    • setIgnorePattern

      public void setIgnorePattern(String ignorePattern)

    • getIgnorePattern

      public String getIgnorePattern()

    • setIncludePattern

      public void setIncludePattern(String includePattern)
      Include only files matching includePattern
      Since:
      6.5

    • getIncludePattern

      public String getIncludePattern()
      Since:
      6.5

    • setVars

      @Deprecated public static void setVars(Map<String,Object> variables, bsh.Interpreter interpreter) throws ScriptException
      Deprecated.
      Use setVars(Map variables, ScriptEngine engine)
      Throws:
      ScriptException

    • setVars

      public static void setVars(Map<String,Object> variables, ScriptEngine engine)
      Called from JConsoleFrame only. Remove later and use our own scopes
      Parameters:
      variables -
      engine -

    • setUsing

      public void setUsing(Object using)

    • getScalingMethod

      public String getScalingMethod()

    • setScalingMethod

      public void setScalingMethod(String scalingMethod)

    • getSmoothScalingType

      public CustomScaler.Type getSmoothScalingType()
      Returns:
      Since:
      15

    • setSmoothScalingType

      public void setSmoothScalingType(CustomScaler.Type smoothScalingType)
      Since:
      15

    • isAcceleratedScaling

      public boolean isAcceleratedScaling()
      Since 8.3.5

    • setAcceleratedScaling

      public void setAcceleratedScaling(boolean hardwareScaling)
      Attempt to use hardware accelerated image scaling. Is usually faster but can produce worse results on some graphics cards Since 8.3.5

    • getDirectoryChaining

      public DirectoryChaining getDirectoryChaining()

    • setDirectoryChaining

      public void setDirectoryChaining(DirectoryChaining directoryChaining)
      Enable sequential traversal of an album tree via nextPage, previousPage, nextIndexPage and previousIndexPage
      Parameters:
      directoryChaining -
      Since:
      24

    • isChainDirectories

      public boolean isChainDirectories()

    • setChainDirectories

      @Deprecated public void setChainDirectories(boolean chain)
      Deprecated.
      Use setDictoryChaining() instead

    • getCreditText

      public AlbumBean.CreditText getCreditText()
      Key for text to use for credit links
      Returns:
      Since:
      10.10

    • setCreditText

      public void setCreditText(AlbumBean.CreditText creditText)
      Set key for text to use for credit links
      Since:
      10.10

    • getFactory

      public AlbumObjectFactory getFactory()