hudson.views
Class ListViewColumn

java.lang.Object
  extended by hudson.views.ListViewColumn
All Implemented Interfaces:
ExtensionPoint, Describable<ListViewColumn>
Direct Known Subclasses:
BuildButtonColumn, ConsoleColumn, JobColumn, LastDurationColumn, LastFailureColumn, LastStableColumn, LastSuccessColumn, StatusColumn, WeatherColumn

public abstract class ListViewColumn
extends Object
implements ExtensionPoint, Describable<ListViewColumn>

Extension point for adding a column to a table rendering of Items, such as ListView.

This object must have the column.jelly. This view is called for each cell of this column. The Item object is passed in the "job" variable. The view should render the <td> tag.

This object may have an additional columHeader.jelly. The default ColmnHeader will render getColumnCaption().

If you opt to be shown by default, there also must be a default constructor, which is invoked to create a list view column in the default configuration.

Originally, this extension point was designed for ListView, but since then it has grown to be applicable to other Views and ItemGroups that render a collection of Items in a tabular format.

Since:
1.279
Author:
Kohsuke Kawaguchi
See Also:
ListViewColumnDescriptor

Nested Class Summary
 
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
 
Field Summary
static DescriptorList<ListViewColumn> LIST
          Deprecated. as of 1.281 Use all() for read access and Extension for registration.
 
Constructor Summary
ListViewColumn()
           
 
Method Summary
static DescriptorExtensionList<ListViewColumn,Descriptor<ListViewColumn>> all()
          Returns all the registered ListViewColumn descriptors.
static List<ListViewColumn> createDefaultInitialColumnList()
          Creates the list of ListViewColumns to be used for newly created ListViews and their likes.
 String getColumnCaption()
          Returns the name of the column that explains what this column means
 Descriptor<ListViewColumn> getDescriptor()
          For compatibility reason, this method may not return a ListViewColumnDescriptor and instead return a plain Descriptor instance.
 boolean shownByDefault()
          Deprecated. as of 1.342. Use ListViewColumnDescriptor.shownByDefault()
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LIST

public static final DescriptorList<ListViewColumn> LIST
Deprecated. as of 1.281 Use all() for read access and Extension for registration.
All registered ListViewColumns.

Constructor Detail

ListViewColumn

public ListViewColumn()
Method Detail

getColumnCaption

@Exported
public String getColumnCaption()
Returns the name of the column that explains what this column means

Returns:
The convention is to use capitalization like "Foo Bar Zot".

all

public static DescriptorExtensionList<ListViewColumn,Descriptor<ListViewColumn>> all()
Returns all the registered ListViewColumn descriptors.


shownByDefault

public boolean shownByDefault()
Deprecated. as of 1.342. Use ListViewColumnDescriptor.shownByDefault()

Whether this column will be shown by default. The default implementation is true.

Since:
1.301

getDescriptor

public Descriptor<ListViewColumn> getDescriptor()
For compatibility reason, this method may not return a ListViewColumnDescriptor and instead return a plain Descriptor instance.

Specified by:
getDescriptor in interface Describable<ListViewColumn>

createDefaultInitialColumnList

public static List<ListViewColumn> createDefaultInitialColumnList()
Creates the list of ListViewColumns to be used for newly created ListViews and their likes.

Since:
1.391


Copyright © 2004-2013 Hudson. All Rights Reserved.