Package com.jalios.jcms.tools
Class CssPacker
java.lang.Object
com.jalios.jcms.tools.AbstractFilePacker
com.jalios.jcms.tools.CssPacker
-
Field Summary
Fields inherited from class com.jalios.jcms.tools.AbstractFilePacker
channel, CHANNEL_PACKER_MINIFY_EXCLUSION_REGEX -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic CheckResultcheckAndMinifyCSS(boolean force, boolean isUnittest) Create a minified version of all CSS found in JCMS.getCSSFilesInPack(Collection<String> cssFiles, String browserName) Returns the set of the URLs created with the CSS packer, respecting the constraints of the browser.protected org.apache.log4j.LoggerReturns the logger to be used for log messages.static voidminifyCSS(boolean force) Create a minified version of all CSS found in JCMS.protected booleanCheck if minification should be performed on each file as opposed to the whole pack.protected StringpostProcessPackContent(String packContent) Move remaining CSS imports to the beginning of the final pack, as required by CSS.protected StringprocessFileContent(String cssRelativeFilePath, File cssFile, String cssFileContent) Process CSS files' contentprotected StringprocessPackContent(String packContent) Process CSS pack's contentMethods inherited from class com.jalios.jcms.tools.AbstractFilePacker
getFilePack, getFilesInPack, getMinifiedFile, isExcludedFromMinification, minifyFile
-
Constructor Details
-
CssPacker
Creates a new CSS packer.- Parameters:
packerDirectory- the relative path of the servlet/jsp that will be outputing the packed css. MUST be specified.- Throws:
IllegalArgumentException- if packerDirectory is nullException- on initialization error
-
-
Method Details
-
processFileContent
protected String processFileContent(String cssRelativeFilePath, File cssFile, String cssFileContent) Process CSS files' content- Specified by:
processFileContentin classAbstractFilePacker- Parameters:
cssRelativeFilePath- the relative path of the file being processedcssFile- the file being processedcssFileContent- the fileContent as read by the AbstractFilePacker- Returns:
- the processed file content, must not return null.
-
processPackContent
Process CSS pack's content- Specified by:
processPackContentin classAbstractFilePacker- Parameters:
packContent- the whole pack content as computed by the AbstractFilePacker- Returns:
- the processed pack content, must not return null.
-
postProcessPackContent
Move remaining CSS imports to the beginning of the final pack, as required by CSS.- Overrides:
postProcessPackContentin classAbstractFilePacker- Parameters:
packContent- the whole pack content as computed by the AbstractFilePacker- Returns:
- the post processed pack content, must not return null.
-
perFileMinificationEnabled
protected boolean perFileMinificationEnabled()Description copied from class:AbstractFilePackerCheck if minification should be performed on each file as opposed to the whole pack.- Specified by:
perFileMinificationEnabledin classAbstractFilePacker- Returns:
- true to use minified version of individual file, false if minification is disabled or enabled on whole pack
-
getLogger
protected org.apache.log4j.Logger getLogger()Description copied from class:AbstractFilePackerReturns the logger to be used for log messages. This methods must be implemented by the file packer.- Specified by:
getLoggerin classAbstractFilePacker- Returns:
Loggerof this packer, must not return null.
-
minifyCSS
public static void minifyCSS(boolean force) Create a minified version of all CSS found in JCMS.This method only process css file if minification is enabled through property
"channel.css-packer.compressor.enabled".
Only files contained in directories css, plugins and js are processed- Parameters:
force- set to true to force generation of minified file even if an up to date apparently exists
-
checkAndMinifyCSS
Create a minified version of all CSS found in JCMS.This method only process css file if minification is enabled through property
"channel.css-packer.compressor.enabled".
Only files contained in directories css, plugins and js are processed- Parameters:
force- set to true to force generation of minified file even if an up to date apparently existsisUnittest- set to true to generate minified file temporarly to check- Returns:
- an instance of CheckResult, with all minification errors, when unittest was requested and packer successfully created, null otherwise
- Since:
- 10.0.9 / JCMS-11077
-
getCSSFilesInPack
Returns the set of the URLs created with the CSS packer, respecting the constraints of the browser.- Parameters:
cssFiles- collection of CSS files to packbrowserName- name of the browser used to find the properties 'channel.packer.xxx' defining the limit values. Ifnull, use 'IE' because it's the most constraining.- Returns:
- Set of the CSS Packer URLs
-