Interface AlbumEngine
- All Known Implementing Classes:
AlbumBean
public interface AlbumEngine
Interface for AlbumBean, providing necessary functionality for running AlbumBean
integrated into a web application
- Since:
- 8.4
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionvoidgetSkin()getStyle()booleanGenerate a web album.voidvoidsetAppendImages(boolean appendImages) Control if all image files are to be rescaled or only new files.Setting appendImages causes image reprocessing only if images are missingvoidsetDirectory(String newDirectory) Set image directory.voidsetLimit(int limit) Limit number of album objects that are to be processed 0 = unlimited Use of this method by 3:rd party developers is discouragedvoidsetOutputDirectory(String newOutputDirectory) voidsetProperties(Properties props) Convenience method that calls the relevant setter methods on this bean depending on the passed properties.voidvoidsetSkinVariables(Map newSkinVariables) voidvoidsetUserVariables(Map newUserVariables) Make album but let jAlbum decide whether to make all or changes
-
Method Details
-
addAlbumBeanListener
-
removeAlbumBeanListener
-
setSkin
-
getSkin
String getSkin() -
setStyle
-
getStyle
String getStyle() -
setSkinVariables
-
getSkinVariables
Map getSkinVariables() -
setUserVariables
-
getUserVariables
Map getUserVariables() -
setProperties
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- Since:
- 8.4
-
setDirectory
Set image directory. Mandatory to call before calling makeAlbum() Fires directory PropertyChangeEvent since 8.4- Parameters:
newDirectory-
-
getDirectory
String getDirectory() -
setOutputDirectory
-
getOutputDirectory
String getOutputDirectory() -
setAppendImages
void setAppendImages(boolean appendImages) Control if all image files are to be rescaled or only new files.Setting appendImages causes image reprocessing only if images are missing- Parameters:
appendImages-
-
isAppendImages
boolean isAppendImages() -
setLimit
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- Since:
- 8.3
-
makeAlbum
MakeResult makeAlbum() throws IllegalArgumentException, IOException, OperationAbortedException, ElementException, ScriptExceptionGenerate a web album. Before calling makeAlbum() you must always call setDirectory() and either call setOutputDirectory() to set an output directory or call setSameDirectory(true); -
smartMakeAlbum
MakeResult smartMakeAlbum() throws IllegalArgumentException, IOException, OperationAbortedException, ElementException, ScriptExceptionMake album but let jAlbum decide whether to make all or changes
-