Package hudson.views

Class ListViewColumn

java.lang.Object

hudson.views.ListViewColumn

All Implemented Interfaces:

ExtensionPoint, Describable<ListViewColumn>

Direct Known Subclasses:

BuildButtonColumn, 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 columnHeader.jelly. The default ColumnHeader 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

Fields

Modifier and Type	Field	Description
static final double	DEFAULT_COLUMNS_ORDINAL_ACTIONS_END
static final double	DEFAULT_COLUMNS_ORDINAL_ACTIONS_START
static final double	DEFAULT_COLUMNS_ORDINAL_ICON_END
static final double	DEFAULT_COLUMNS_ORDINAL_ICON_START
static final double	DEFAULT_COLUMNS_ORDINAL_PROPERTIES_END
static final double	DEFAULT_COLUMNS_ORDINAL_PROPERTIES_START
static final DescriptorList<ListViewColumn>	LIST	Deprecated. as of 1.281 Use all() for read access and Extension for registration.

Constructor Summary

Constructors

Constructor	Description
ListViewColumn()

Method Summary

Modifier and Type	Method	Description
static DescriptorExtensionList<ListViewColumn,Descriptor<ListViewColumn>>	all()	Returns all the registered ListViewColumn descriptors.
static List<ListViewColumn>	createDefaultInitialColumnList()	Deprecated. use createDefaultInitialColumnList(Class)
static List<ListViewColumn>	createDefaultInitialColumnList(View view)	Creates the list of ListViewColumns to be used for a ListViews and their likes.
static List<ListViewColumn>	createDefaultInitialColumnList(Class<? extends View> context)	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.

Methods inherited from class java.lang.Object

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

Field Details

LIST

@Deprecated
public static final DescriptorList<ListViewColumn> LIST

Deprecated.

as of 1.281 Use all() for read access and Extension for registration.

All registered ListViewColumns.

DEFAULT_COLUMNS_ORDINAL_ICON_START

public static final double DEFAULT_COLUMNS_ORDINAL_ICON_START

See Also:

• Constant Field Values

DEFAULT_COLUMNS_ORDINAL_ICON_END

public static final double DEFAULT_COLUMNS_ORDINAL_ICON_END

See Also:

• Constant Field Values

DEFAULT_COLUMNS_ORDINAL_PROPERTIES_START

public static final double DEFAULT_COLUMNS_ORDINAL_PROPERTIES_START

See Also:

• Constant Field Values

DEFAULT_COLUMNS_ORDINAL_PROPERTIES_END

public static final double DEFAULT_COLUMNS_ORDINAL_PROPERTIES_END

See Also:

• Constant Field Values

DEFAULT_COLUMNS_ORDINAL_ACTIONS_START

public static final double DEFAULT_COLUMNS_ORDINAL_ACTIONS_START

See Also:

• Constant Field Values

DEFAULT_COLUMNS_ORDINAL_ACTIONS_END

public static final double DEFAULT_COLUMNS_ORDINAL_ACTIONS_END

See Also:

• Constant Field Values

Constructor Details

ListViewColumn

public ListViewColumn()

Method Details

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

@Deprecated
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

@Deprecated
public static List<ListViewColumn> createDefaultInitialColumnList()

Deprecated.

use createDefaultInitialColumnList(Class)

Creates the list of ListViewColumns to be used for newly created ListViews and their likes.

Since:

1.391

createDefaultInitialColumnList

public static List<ListViewColumn> createDefaultInitialColumnList(Class<? extends View> context)

Creates the list of ListViewColumns to be used for newly created ListViews and their likes.

Since:

2.37

See Also:

• ListView.initColumns()

createDefaultInitialColumnList

public static List<ListViewColumn> createDefaultInitialColumnList(View view)

Creates the list of ListViewColumns to be used for a ListViews and their likes.

Since:

2.37

See Also:

• View.getColumns()