File D:\maven-qcr-plugin-testsunitaires\qcr4java\jenkins-master\target\site\qc\core\src\main\java\hudson\widgets\Widget.java.html

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24 package hudson.widgets;
25
26 import hudson.ExtensionPoint;
27
28 /**
29 * Box to be rendered in the side panel.
30 *
31 * <h2>Views</h2>
32 * <ul>
33 * <li><b>index.jelly</b> should display the widget. It should have:
34 * &lt;l:pane width="2" title="..."> ...body... &lt;/l:pane> structure.
35 *
36 * @author Kohsuke Kawaguchi
37 * @since 1.146
38 * @see jenkins.model.Jenkins#getWidgets()
39 */
40 public abstract class Widget implements ExtensionPoint {
41 /**
42 * Gets the URL path name.
43 *
44 * <p>
45 * For example, if this method returns "xyz", and if the parent object
46 * (that this widget is associated with) is bound to /foo/bar/zot,
47 * then this widget object will be exposed to /foo/bar/zot/xyz.
48 *
49 * <p>
50 * This method is useful when the widget needs to expose additional URLs,
51 * for example for serving AJAX requests.
52 *
53 * <p>
54 * This method should return a string that's unique among other {@link Widget}s.
55 * The default implementation returns the unqualified class name.
56 */
57 public String getUrlName() {
58 return getClass().getSimpleName();
59 }
60 }
61