Package jenkins.model.navigation

Class SearchAction

java.lang.Object
jenkins.model.navigation.SearchAction
All Implemented Interfaces:
ExtensionPoint, Action, ModelObject, RootAction
@Extension(ordinal=999.0) public class SearchAction extends Object implements RootAction
TODO

  • Constructor Details

    • SearchAction

      public SearchAction()

  • Method Details

    • getIconFileName

      public String getIconFileName()
      Description copied from interface: Action
      Gets the name of the icon.
      Specified by:
      getIconFileName in interface Action
      Returns:
      If the icon name is prefixed with "symbol-", a Jenkins Symbol will be used.

      If just a file name (like "abc.gif") is returned, it will be interpreted as a file name inside /images/24x24. This is useful for using one of the stock images.

      If an absolute file name that starts from '/' is returned (like "/plugin/foo/abc.gif"), then it will be interpreted as a path from the context root of Jenkins. This is useful to pick up image files from a plugin.

      Finally, return null to hide it from the task list. This is normally not very useful, but this can be used for actions that only contribute floatBox.jelly and no task list item. The other case where this is useful is to avoid showing links that require a privilege when the user is anonymous.

      See Also:

    • getDisplayName

      public String getDisplayName()
      Description copied from interface: Action
      Gets the string to be displayed. The convention is to capitalize the first letter of each word, such as "Test Result".
      Specified by:
      getDisplayName in interface Action
      Specified by:
      getDisplayName in interface ModelObject
      Returns:
      Can be null in case the action is hidden.

    • getUrlName

      public String getUrlName()
      Description copied from interface: Action
      Gets the URL path name.

      For example, if this method returns "xyz", and if the parent object (that this action is associated with) is bound to /foo/bar/zot, then this action object will be exposed to /foo/bar/zot/xyz.

      This method should return a string that's unique among other Actions.

      The returned string can be an absolute URL, like "http://www.sun.com/", which is useful for directly connecting to external systems.

      If the returned string starts with '/', like '/foo', then it's assumed to be relative to the context path of the Jenkins webapp.

      Specified by:
      getUrlName in interface Action
      Returns:
      null if this action object doesn't need to be bound to web (when you do that, be sure to also return null from Action.getIconFileName().
      See Also:

    • isPrimaryAction

      public boolean isPrimaryAction()
      Description copied from interface: RootAction
      Identifies if the action is a primary action. Primary actions may be handled differently in the UI (for example, by always showing on the header rather than in an actions dropdown). In almost all cases this should return false which is the default. Examples of a Primary action would be where actions would be used regularly or they would need to be prominent to convey some status. As a concrete example, an action that provides a Help action with a submenu containing various different links, would be a prime candidate for this to return true. If your action has the possibility of a badge then this is another indicator that the action should return true (or otherwise restructured).
      Specified by:
      isPrimaryAction in interface RootAction
      Returns:
      true if and only if this action should be considered primary.