@Extension(ordinal=1000.0) @Symbol(value={"freeStyle","freeStyleJob"}) public static class FreeStyleProject.DescriptorImpl extends AbstractProject.AbstractProjectDescriptor
Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self
clazz
Constructor and Description |
---|
DescriptorImpl() |
Modifier and Type | Method and Description |
---|---|
String |
getCategoryId()
Used to categorize this kind of item type.
|
String |
getDescription()
A description of this kind of item type.
|
String |
getDisplayName()
Human readable name of this kind of configurable object.
|
String |
getIconClassName()
Get the Item's Icon class specification e.g.
|
String |
getIconFilePathPattern()
Represents a file path pattern to get the Item icon in different sizes.
|
FreeStyleProject |
newInstance(ItemGroup parent,
String name)
Creates a new
TopLevelItem for the specified parent. |
doAutoCompleteAssignedLabelString, doAutoCompleteLabel, doAutoCompleteUpstreamProjects, doCheckAssignedLabelString, doCheckCustomWorkspace, doCheckLabel, getApplicableSCMCheckoutStrategyDescriptors, isApplicable, validateLabelExpression
all, checkApplicableIn, getIconFilePath, isApplicableIn, newInstance, newInstance, testInstance
addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap
public String getDisplayName()
TopLevelItemDescriptor
Class.getSimpleName()
on Descriptor.clazz
, so for example MyThing
from some.pkg.MyThing.DescriptorImpl
.
Historically some implementations returned null as a way of hiding the descriptor from the UI,
but this is generally managed by an explicit method such as isEnabled
or isApplicable
.
Used as the caption when the user chooses what item type to create.
The descriptor implementation also needs to have newInstanceDetail.jelly
script, which will be used to render the text below the caption
that explains the item type.
getDisplayName
in class TopLevelItemDescriptor
public FreeStyleProject newInstance(ItemGroup parent, String name)
TopLevelItemDescriptor
TopLevelItem
for the specified parent.newInstance
in class TopLevelItemDescriptor
public String getDescription()
TopLevelItemDescriptor
getDescription
in class TopLevelItemDescriptor
public String getCategoryId()
TopLevelItemDescriptor
ItemCategory
getCategoryId
in class TopLevelItemDescriptor
ItemCategory.UncategorizedCategory#getId()
by default.public String getIconFilePathPattern()
TopLevelItemDescriptor
:size
represents the different
icon sizes used commonly in Jenkins project: 16x16, 24x24, 32x32 or 48x48getIconFilePathPattern
in class TopLevelItemDescriptor
getIconFilePathPattern()
public String getIconClassName()
TopLevelItemDescriptor
Note: do NOT include icon size specifications (such as 'icon-sm').
getIconClassName
in interface org.jenkins.ui.icon.IconSpec
getIconClassName
in class TopLevelItemDescriptor
Copyright © 2004–2019. All rights reserved.