Class FolderIcon
- java.lang.Object
-
- hudson.model.AbstractStatusIcon
-
- com.cloudbees.hudson.plugins.folder.FolderIcon
-
- All Implemented Interfaces:
ExtensionPoint
,Describable<FolderIcon>
,StatusIcon
,IconSpec
- Direct Known Subclasses:
StockFolderIcon
public abstract class FolderIcon extends AbstractStatusIcon implements Describable<FolderIcon>, ExtensionPoint, IconSpec
RendersStatusIcon
for a folder.Possible subtypes can range from dumb icons that always render the same thing to smarter icons that change its icon based on the properties/contents of the folder.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Constructor Summary
Constructors Constructor Description FolderIcon()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FolderIconDescriptor
getDescriptor()
String
getIconClassName()
protected String
iconClassNameImageOf(String size)
protected void
setFolder(Folder folder)
Deprecated.protected void
setOwner(AbstractFolder<?> folder)
Called byAbstractFolder
to set the owner that this icon is used for.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface hudson.model.StatusIcon
getDescription, getImageOf
-
-
-
-
Method Detail
-
setOwner
protected void setOwner(AbstractFolder<?> folder)
Called byAbstractFolder
to set the owner that this icon is used for.If you are implementing
FolderIcon
that changes the behaviour based on the contents/properties of the folder, store the folder object to a field and use that.- Parameters:
folder
- the folder.
-
getIconClassName
public String getIconClassName()
- Specified by:
getIconClassName
in interfaceIconSpec
-
setFolder
@Deprecated protected void setFolder(Folder folder)
Deprecated.- Parameters:
folder
- the folder.
-
getDescriptor
public FolderIconDescriptor getDescriptor()
- Specified by:
getDescriptor
in interfaceDescribable<FolderIcon>
-
-