Package org.opencms.workplace.explorer
Class CmsIconRule
- java.lang.Object
-
- org.opencms.workplace.explorer.CmsIconRule
-
- All Implemented Interfaces:
java.io.Serializable
public class CmsIconRule extends java.lang.Object implements java.io.Serializable
An icon configuration rule for an explorer type.Each rule consists of a file name extension and (at most) two icon file names for icons which should be used for resources with that extension.
- Since:
- 8.0.0
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description CmsIconRule(java.lang.String extension, java.lang.String icon, java.lang.String bigIcon, java.lang.String smallIconStyle, java.lang.String bigIconStyle)
Creates a new icon rule.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
java.lang.String
getBigIcon()
Returns the big icon's file name.java.lang.String
getBigIconIfAvailable()
Returns the biggest icon available.java.lang.String
getBigIconStyle()
Returns the big icon CSS style class.java.lang.String
getExtension()
Returns the file name extension for this rule.java.lang.String
getIcon()
Returns the small icon's file name.java.lang.String
getSmallIconStyle()
Returns the small icon CSS style class.
-
-
-
Constructor Detail
-
CmsIconRule
public CmsIconRule(java.lang.String extension, java.lang.String icon, java.lang.String bigIcon, java.lang.String smallIconStyle, java.lang.String bigIconStyle)
Creates a new icon rule.- Parameters:
extension
- the file name extensionicon
- the small icon's file namebigIcon
- the big icon's file namesmallIconStyle
- the small icon CSS style classbigIconStyle
- the big icon CSS style class
-
-
Method Detail
-
clone
public java.lang.Object clone()
- Overrides:
clone
in classjava.lang.Object
- See Also:
Object.clone()
-
getBigIcon
public java.lang.String getBigIcon()
Returns the big icon's file name.- Returns:
- the big icon's file name
-
getBigIconIfAvailable
public java.lang.String getBigIconIfAvailable()
Returns the biggest icon available.- Returns:
- the biggest icon available
-
getBigIconStyle
public java.lang.String getBigIconStyle()
Returns the big icon CSS style class.- Returns:
- the big icon style
-
getExtension
public java.lang.String getExtension()
Returns the file name extension for this rule.- Returns:
- the file name extension for this rule
-
getIcon
public java.lang.String getIcon()
Returns the small icon's file name.- Returns:
- the small icon's file name
-
getSmallIconStyle
public java.lang.String getSmallIconStyle()
Returns the small icon CSS style class.- Returns:
- the small icon style
-
-