public class ViewProperty extends Object implements ReconfigurableDescribable<ViewProperty>, ExtensionPoint
View
.
Plugin
s can extend this to define custom properties for View
s.
ViewProperty
s show up in the view configuration screen, and they are
persisted with the view object.
Configuration screen should be defined in config.jelly
.
Within this page, the ViewProperty
instance is available as
the instance
EL variable (while the it
EL variable
refers to the View
.
ExtensionPoint.LegacyInstancesAreScopedToHudson
Modifier and Type | Field and Description |
---|---|
protected View |
view
The view object that owns this property.
|
Constructor and Description |
---|
ViewProperty() |
Modifier and Type | Method and Description |
---|---|
static DescriptorExtensionList<ViewProperty,ViewPropertyDescriptor> |
all() |
ViewPropertyDescriptor |
getDescriptor()
Gets the descriptor for this instance.
|
ViewProperty |
reconfigure(org.kohsuke.stapler.StaplerRequest req,
net.sf.json.JSONObject form)
When a parent/owner object of a Describable gets a config form submission and instances are
recreated, this method is invoked on the existing instance (meaning the 'this' reference
points to the existing instance) to create a new instance to be added to the parent/owner object.
|
protected transient View view
public ViewPropertyDescriptor getDescriptor()
Describable
Descriptor
is a singleton for every concrete Describable
implementation, so if a.getClass() == b.getClass()
then by default
a.getDescriptor() == b.getDescriptor()
as well.
(In rare cases a single implementation class may be used for instances with distinct descriptors.)
getDescriptor
in interface Describable<ViewProperty>
public static DescriptorExtensionList<ViewProperty,ViewPropertyDescriptor> all()
public ViewProperty reconfigure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject form) throws Descriptor.FormException
ReconfigurableDescribable
The default implementation of this should be the following:
return form==null ? null : getDescriptor().newInstance(req, form);
reconfigure
in interface ReconfigurableDescribable<ViewProperty>
req
- The current HTTP request being processed.form
- JSON fragment that corresponds to this describable object.
If the newly submitted form doesn't include a fragment for this describable
(meaning the user has de-selected your descriptor), then this argument is null.Descriptor.FormException
Copyright © 2004–2021. All rights reserved.