Package jenkins.appearance

Class AppearanceCategory

java.lang.Object

jenkins.model.GlobalConfigurationCategory

jenkins.appearance.AppearanceCategory

All Implemented Interfaces:

ExtensionPoint, ModelObject

@Extension
public class AppearanceCategory
extends GlobalConfigurationCategory

Global configuration of appearance configuration.

This should be used for Plugins that contribute to the look and feel of Jenkins. Theming, header and footer changes, information density are all good examples. API plugins for UI components that are used by other plugins also fit into that, e.g. source code display.

Configuration specific to a single plugin that is not related to the overall look and feel of Jenkins may not belong here.

If a plugin has a single global configuration it should separate appearance and general configuration to different classes.

Nested Class Summary

Nested classes/interfaces inherited from class jenkins.model.GlobalConfigurationCategory

GlobalConfigurationCategory.Security, GlobalConfigurationCategory.Unclassified

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
AppearanceCategory()

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()
String	getShortDescription()	One-line plain text message that explains what this category is about.

Methods inherited from class jenkins.model.GlobalConfigurationCategory

all, get

Methods inherited from class java.lang.Object

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

Constructor Details

AppearanceCategory

public AppearanceCategory()

Method Details

getShortDescription

public String getShortDescription()

Description copied from class: GlobalConfigurationCategory

One-line plain text message that explains what this category is about. This can be used in the UI to help the user pick the right category. The text should be longer than ModelObject.getDisplayName()

Specified by:

getShortDescription in class GlobalConfigurationCategory

getDisplayName

public String getDisplayName()