Package hudson.model

Class ViewPropertyDescriptor

java.lang.Object

hudson.model.Descriptor<ViewProperty>

hudson.model.ViewPropertyDescriptor

All Implemented Interfaces:

Saveable, OnMaster

public abstract class ViewPropertyDescriptor
extends Descriptor<ViewProperty>

Descriptor for ViewProperty

Since:

1.406

Author:

Stephen Connolly

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ViewPropertyDescriptor()	Infers the type of the corresponding Describable from the outer class.
protected	ViewPropertyDescriptor(Class<? extends ViewProperty> clazz)

Method Summary

Modifier and Type	Method	Description
boolean	isEnabledFor(View view)	Whether or not the described property is enabled in the current context.
ViewProperty	newInstance(View view)	Creates a default instance of ViewProperty to be associated with View object that wasn't created from a persisted XML data.

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewPropertyDescriptor

protected ViewPropertyDescriptor(Class<? extends ViewProperty> clazz)

ViewPropertyDescriptor

protected ViewPropertyDescriptor()

Infers the type of the corresponding Describable from the outer class. This version works when you follow the common convention, where a descriptor is written as the static nested class of the describable class.

Method Detail

newInstance

public ViewProperty newInstance(View view)

Creates a default instance of ViewProperty to be associated with View object that wasn't created from a persisted XML data.

See View class javadoc for more details about the life cycle of View and when this method is invoked.

Returns:

null if the implementation choose not to add any property object for such view.

isEnabledFor

public boolean isEnabledFor(View view)

Whether or not the described property is enabled in the current context. Defaults to true. Over-ride in sub-classes as required.

Returning false from this method essentially has the same effect of making core behaves as if this ViewPropertyDescriptor is not a part of ViewProperty.all().

This mechanism is useful if the availability of the property is contingent of some other settings.

Parameters:

view - View for which this property is considered. Never null.