src/java/de/uapcore/lightpit/MenuEntry.java

Sat, 16 Dec 2017 20:19:28 +0100

author
Mike Becker <universe@uap-core.de>
date
Sat, 16 Dec 2017 20:19:28 +0100
changeset 10
89e3e6e28b69
child 11
737ab27e37b3
permissions
-rw-r--r--

implements automatic menu generation from module information

     1 /*
     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
     3  * 
     4  * Copyright 2017 Mike Becker. All rights reserved.
     5  * 
     6  * Redistribution and use in source and binary forms, with or without
     7  * modification, are permitted provided that the following conditions are met:
     8  *
     9  *   1. Redistributions of source code must retain the above copyright
    10  *      notice, this list of conditions and the following disclaimer.
    11  *
    12  *   2. Redistributions in binary form must reproduce the above copyright
    13  *      notice, this list of conditions and the following disclaimer in the
    14  *      documentation and/or other materials provided with the distribution.
    15  *
    16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
    20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    26  * POSSIBILITY OF SUCH DAMAGE.
    27  * 
    28  */
    29 package de.uapcore.lightpit;
    31 /**
    32  * Maps a resource key for the menu label to the path name for the underlying
    33  * site.
    34  * 
    35  * Objects of this class are internally instantiated by the
    36  * {@link ModuleManager}.
    37  */
    38 public class MenuEntry {
    40     private ResourceKey resourceKey;
    41     private String pathName;
    43     public MenuEntry() {
    44     }
    46     public MenuEntry(ResourceKey resourceKey, String pathName) {
    47         this.resourceKey = resourceKey;
    48         this.pathName = pathName;
    49     }
    51     /**
    52      * Sets the resource key, which is used to look up the menu label.
    53      * 
    54      * @param resourceKey the key for the resource bundle
    55      */
    56     public void setResourceKey(ResourceKey resourceKey) {
    57         this.resourceKey = resourceKey;
    58     }
    60     /**
    61      * Retrieves the resource key.
    62      * 
    63      * @return the key for the resource bundle
    64      */
    65     public ResourceKey getResourceKey() {
    66         return resourceKey;
    67     }
    69     /**
    70      * Sets the path name of the web page accessed via this menu entry.
    71      * 
    72      * @param pathName path name relative to the context path
    73      */
    74     public void setPathName(String pathName) {
    75         this.pathName = pathName;
    76     }
    78     /**
    79      * Retrieves the path name of the web page accessed via this menu entry.
    80      * 
    81      * @return path name relative to the context path
    82      */
    83     public String getPathName() {
    84         return pathName;
    85     }
    87 }

mercurial