View Javadoc

1   /*
2    * Copyright 2013 smartics, Kronseder & Reiner GmbH
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package de.smartics.resteasy.hypermedia.renderer.i18n;
17  
18  /**
19   * The keys to access link metadata in resource sources.
20   */
21  public final class LinkMetadataKeys
22  {
23    // ********************************* Fields *********************************
24  
25    // --- constants ------------------------------------------------------------
26  
27    /**
28     * The key to select the title for a link.
29     * <p>
30     * The value of this constant is {@value}.
31     * </p>
32     */
33    public static final String TITLE = "title";
34  
35    /**
36     * The key to select the label for a link.
37     * <p>
38     * The value of this constant is {@value}.
39     * </p>
40     */
41    public static final String LABEL = "label";
42  
43    /**
44     * The key to select the short label for a link.
45     * <p>
46     * The value of this constant is {@value}.
47     * </p>
48     */
49    public static final String SHORT_LABEL = "shortLabel";
50  
51    /**
52     * The key to select the help text for a link.
53     * <p>
54     * The value of this constant is {@value}.
55     * </p>
56     */
57    public static final String HELP = "help";
58  
59    /**
60     * The key to select the access key for a link.
61     * <p>
62     * The value of this constant is {@value}.
63     * </p>
64     */
65    public static final String ACCESS_KEY = "accessKey";
66  
67    /**
68     * The key to select the tab index for a link.
69     * <p>
70     * The value of this constant is {@value}.
71     * </p>
72     */
73    public static final String TAB_INDEX = "tabIndex";
74  
75    /**
76     * The key to select the CSS class for a link.
77     * <p>
78     * The value of this constant is {@value}.
79     * </p>
80     */
81    public static final String CSS_CLASS = "cssClass";
82  
83    /**
84     * The key to select the hidden flag value for a link.
85     * <p>
86     * The value of this constant is {@value}.
87     * </p>
88     */
89    public static final String HIDDEN = "hidden";
90  
91    /**
92     * The key to select the direction value for a link.
93     * <p>
94     * The value of this constant is {@value}.
95     * </p>
96     */
97    public static final String DIR = "dir";
98  
99    /**
100    * The key to select the id for a link.
101    * <p>
102    * The value of this constant is {@value}.
103    * </p>
104    */
105   public static final String ID = "id";
106 
107   /**
108    * The key to select the media for a link.
109    * <p>
110    * The value of this constant is {@value}.
111    * </p>
112    */
113   public static final String MEDIA = "media";
114 
115   /**
116    * The key to select the target for a link.
117    * <p>
118    * The value of this constant is {@value}.
119    * </p>
120    */
121   public static final String TARGET = "target";
122 
123   /**
124    * The key to select the target for a link.
125    * <p>
126    * The value of this constant is {@value}.
127    * </p>
128    */
129   public static final String CONTEXT_MENU = "contextMenu";
130 
131   // --- members --------------------------------------------------------------
132 
133   // ****************************** Initializer *******************************
134 
135   // ****************************** Constructors ******************************
136 
137   private LinkMetadataKeys()
138   {
139   }
140 
141   // ****************************** Inner Classes *****************************
142 
143   // ********************************* Methods ********************************
144 
145   // --- init -----------------------------------------------------------------
146 
147   // --- get&set --------------------------------------------------------------
148 
149   // --- business -------------------------------------------------------------
150 
151   // --- object basics --------------------------------------------------------
152 
153 }