View Javadoc

1   package net.sf.navigator.menu;
2   
3   
4   /**
5    *
6    * @author  ssayles
7    * @author  mraible
8    * @version
9    */
10  public abstract class MenuBase implements Component {
11      //~ Instance fields ========================================================
12  
13      /** Holds value of property action, that is, Struts Logical Action Name. */
14      protected String action;
15  
16      /** Align menu 'left','right','top','bottom' ...and other alignment of particular menu system */
17      protected String align;
18      
19      /** Holds value of property altImage. */
20      protected String altImage;
21  
22      /** Holds value of property description. */
23      protected String description;
24  
25      /** Holds value of property forward. */
26      protected String forward;
27  
28      /** Holds value of property height. */
29      protected String height;
30  
31      /** Holds value of property image. */
32      protected String image;
33  
34      /** Holds value of property location. */
35      protected String location;
36  
37      /** Holds value of property name. */
38      protected String name;
39  
40      /** Holds value of property onclick. */
41      protected String onclick;
42  
43      /** Holds value of property ondblclick. */
44      protected String ondblclick;
45  
46      /** Holds value of property onmouseout. */
47      protected String onmouseout;
48  
49      /** Holds value of property onmouseover. */
50      protected String onmouseover;
51  
52      /** Holds value of property page. */
53      protected String page;
54  
55      /** Holds value of property roles. */
56      protected String roles;
57  
58      /** Holds value of property target. */
59      protected String target;
60  
61      /** Holds value of property title. */
62      protected String title;
63  
64      /** Holds value of property toolTip. */
65      protected String toolTip;
66  
67      /** Holds value of property width. */
68      protected String width;
69  
70      /** Holds parsed (with variables) url that is used to render a link */
71      private String url;
72      
73      /** Holds value of property onContextMenu */
74      protected String onContextMenu;
75  
76      /**
77       * Holds value of property module; a Struts module prefix that overrides the current module.
78       *
79       * <p>The default module is specified by <code>""</code>.  Any non-default module should begin with <code>"/"</code>.
80       */
81      protected String module;
82  
83      //~ Methods ================================================================
84  
85      /**
86       * Sets the value for action.
87       * @param action New value of property action.
88       */
89      public void setAction(String action) {
90          this.action = action;
91      }
92  
93      /**
94       * Returns the value for action.
95       * @return Value of property action.
96       */
97      public String getAction() {
98          return this.action;
99      }
100 
101     /**
102      * Returns the value for align.
103      * @return Value of property align.
104      */
105     public String getAlign() {
106         return align;
107     }
108     
109     /**
110      * Sets the value for align.
111      * @param align New value of property align.
112      */
113     public void setAlign(String align) {
114         this.align = align;
115     }
116     
117     /** Setter for property altImage.
118      * @param altImage New value of property altImage.
119      */
120     public void setAltImage(String altImage) {
121         this.altImage = altImage;
122     }
123 
124     /** Getter for property altImage.
125      * @return Value of property altImage.
126      */
127     public String getAltImage() {
128         return altImage;
129     }
130 
131     /** Setter for property description.
132      * @param description New value of property description.
133      */
134     public void setDescription(String description) {
135         this.description = description;
136     }
137 
138     /** Getter for property description.
139      * @return Value of property description.
140      */
141     public String getDescription() {
142         return description;
143     }
144 
145     /**
146      * Sets the forward.
147      * @param forward The forward to set
148      */
149     public void setForward(String forward) {
150         this.forward = forward;
151     }
152 
153     /**
154      * @return String
155      */
156     public String getForward() {
157         return forward;
158     }
159 
160     /**
161      * @param height
162      */
163     public void setHeight(String height) {
164         this.height = height;
165     }
166 
167     /**
168      * @return
169      */
170     public String getHeight() {
171         return height;
172     }
173 
174     /** Setter for property image.
175      * @param image New value of property image.
176      */
177     public void setImage(String image) {
178         this.image = image;
179     }
180 
181     /** Getter for property image.
182      * @return Value of property image.
183      */
184     public String getImage() {
185         return image;
186     }
187 
188     /** Setter for property location.
189      * @param location New value of property location.
190      */
191     public void setLocation(String location) {
192         this.location = location;
193     }
194 
195     /** Getter for property location.
196      * @return Value of property location.
197      */
198     public String getLocation() {
199         return location;
200     }
201 
202     /** Setter for property name.
203      * @param name New value of property name.
204      */
205     public void setName(String name) {
206         this.name = name;
207     }
208 
209     /** Getter for property name.
210      * @return Value of property name.
211      */
212     public String getName() {
213         return name;
214     }
215 
216     /** Setter for property onclick.
217      * @param onclick New value of property onclick.
218      */
219     public void setOnclick(String onclick) {
220         this.onclick = onclick;
221     }
222 
223     /** Getter for property onclick.
224      * @return Value of property onclick.
225      */
226     public String getOnclick() {
227         return onclick;
228     }
229 
230     /** Setter for property onmouseout.
231      * @param onmouseout New value of property onmouseout.
232      */
233     public void setOnmouseout(String onmouseout) {
234         this.onmouseout = onmouseout;
235     }
236 
237     /** Getter for property onmouseout.
238      * @return Value of property onmouseout.
239      */
240     public String getOnmouseout() {
241         return onmouseout;
242     }
243 
244     /** Setter for property onmouseover.
245      * @param onmouseover New value of property onmouseover.
246      */
247     public void setOnmouseover(String onmouseover) {
248         this.onmouseover = onmouseover;
249     }
250 
251     /** Getter for property onmouseover.
252      * @return Value of property onmouseover.
253      */
254     public String getOnmouseover() {
255         return onmouseover;
256     }
257 
258     /**
259      * Sets the value for page.
260      * @param page New value of property page.
261      */
262     public void setPage(String page) {
263         this.page = page;
264     }
265 
266     /**
267      * Returns the value for page.
268      * @return Value of property page.
269      */
270     public String getPage() {
271         return this.page;
272     }
273 
274     /**
275      * Sets the roles.
276      * @param roles The roles to set
277      */
278     public void setRoles(String roles) {
279         this.roles = roles;
280     }
281 
282     /**
283      * Returns the roles.
284      * @return String
285      */
286     public String getRoles() {
287         return roles;
288     }
289 
290     /** Setter for property target.
291      * @param target New value of property target.
292      */
293     public void setTarget(String target) {
294         this.target = target;
295     }
296 
297     /** Getter for property target.
298      * @return Value of property target.
299      */
300     public String getTarget() {
301         return target;
302     }
303 
304     /** Setter for property title.
305      * @param title New value of property title.
306      */
307     public void setTitle(String title) {
308         this.title = title;
309     }
310 
311     /** Getter for property title.
312      * @return Value of property title.
313      */
314     public String getTitle() {
315         return title;
316     }
317 
318     /** Setter for property toolTip.
319      * @param toolTip New value of property toolTip.
320      */
321     public void setToolTip(String toolTip) {
322         this.toolTip = toolTip;
323     }
324 
325     /** Getter for property toolTip.
326      * @return Value of property toolTip.
327      */
328     public String getToolTip() {
329         return toolTip;
330     }
331 
332     /**
333      * @param url
334      */
335     public void setUrl(String url) {
336         this.url = url;
337     }
338 
339     /**
340      * @return
341      */
342     public String getUrl() {
343         return url;
344     }
345 
346     /**
347      * Sets the width.
348      * @param width The width to set
349      */
350     public void setWidth(String width) {
351         this.width = width;
352     }
353 
354     /**
355      * @return String
356      */
357     public String getWidth() {
358         return width;
359     }
360     /**
361      * @return
362      */
363     public String getOnContextMenu() {
364         return onContextMenu;
365     }
366 
367     /**
368      * @param string
369      */
370     public void setOnContextMenu(String string) {
371         onContextMenu = string;
372     }
373 
374     /**
375      * Returns the ondblclick.
376      * @return String
377      */
378     public String getOndblclick() {
379         return ondblclick;
380     }
381 
382     /**
383      * Sets the ondblclick.
384      * @param ondblclick The ondblclick to set
385      */
386     public void setOndblclick(String ondblclick) {
387         this.ondblclick = ondblclick;
388     }
389 
390     public String getModule() {
391         return module;
392     }
393 
394     public void setModule(String module) {
395         this.module = module;
396     }
397 }