org.opencms.workplace.explorer
Class CmsIconRule

java.lang.Object
  org.opencms.workplace.explorer.CmsIconRule

public class CmsIconRule
extends java.lang.Object

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

Constructor Summary

CmsIconRule(java.lang.String extension, java.lang.String icon, java.lang.String bigIcon)
Creates a new icon rule.

Method Summary

java.lang.String	getBigIcon() Returns the big icon's file name.
java.lang.String	getBigIconIfAvailable() Returns the biggest icon available.
java.lang.String	getExtension() Returns the file name extension for this rule.
java.lang.String	getIcon() Returns the small icon's file name.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsIconRule

public CmsIconRule(java.lang.String extension,
                   java.lang.String icon,
                   java.lang.String bigIcon)

Creates a new icon rule.

Parameters:

extension - the file name extension

icon - the small icon's file name

bigIcon - the big icon's file name

Method Detail

getBigIconIfAvailable

public java.lang.String getBigIconIfAvailable()

Returns the biggest icon available.

Returns:

the biggest icon available

getBigIcon

public java.lang.String getBigIcon()

Returns the big icon's file name.

Returns:

the big icon's file name

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