IndependentModeler/src/cz/cvut/promod/services/menuService/utils/MenuItemPosition.java

   1 package cz.cvut.promod.services.menuService.utils;
   2
   3 import org.apache.log4j.Logger;
   4
   5 /**
   6  * ProMod, master thesis project
   7  * User: Petr Zverina, petr.zverina@gmail.com
   8  * Date: 1:46:34, 2.2.2010
   9  */
  10
  11 /**
  12  * Specifies the menu item hierarchical and relative or absolute position in menu.
  13  */
  14 public final class MenuItemPosition{
  15
  16     private static final Logger LOG = Logger.getLogger(MenuItemPosition.class);
  17
  18     /**
  19      * Specifies relative menu item position
  20      */
  21     public static enum PlacementStyle {
  22         /** First item in menu. */
  23         FIRST,
  24
  25         /** Last item in menu. */
  26         LAST,
  27
  28         /** Group menu item having the same text. Last if there is no name duplicity. */
  29         GROUPED
  30     }
  31
  32     private final PositionInfo positionInfo;
  33     private final String hierarchicalPlacement;
  34
  35     /**
  36      * Constructs new MenuItemPosition holding hierarchical placement information.
  37      *
  38      * @param hierarchicalPlacement is the info about hierarchical position for new menu item
  39      */
  40     public MenuItemPosition(final String hierarchicalPlacement){
  41         positionInfo = new PositionInfo();
  42         this.hierarchicalPlacement = hierarchicalPlacement;
  43     }
  44
  45     /**
  46      * Constructs new MenuItemPosition holding hierarchical placement information and relative position.
  47      *
  48      * @param hierarchicalPlacement is the info about hierarchical position for new menu item
  49      *
  50      * @param placementStyle defines relative menu item position in the menu
  51      */
  52     public MenuItemPosition(final String hierarchicalPlacement, final PlacementStyle placementStyle){
  53         this(hierarchicalPlacement);
  54
  55         positionInfo.setRelativePosition(placementStyle);
  56     }
  57
  58     /**
  59      * Constructs new MenuItemPosition holding hierarchical placement information and absolute position.
  60      *
  61      * @param hierarchicalPlacement is the info about hierarchical position for new menu item
  62      *
  63      * @param position defines absolute menu item position in the menu
  64      */
  65     public MenuItemPosition(final String hierarchicalPlacement, final int position){
  66         this(hierarchicalPlacement);
  67
  68         if(position < 0){
  69             LOG.error("Wrong menu position for menu item. Position has been set to zero.");
  70             positionInfo.setPosition(0);
  71         } else {
  72             positionInfo.setPosition(position);
  73         }
  74     }
  75
  76     /**
  77      * Returns required hierarchical placement information.
  78      *
  79      * @return hierarchical placement information
  80      */
  81     public String getHierarchicalPlacement() {
  82         return hierarchicalPlacement;
  83     }
  84
  85     /**
  86      * Returns absolute position for menu item.
  87      *
  88      * @return absolute position
  89      */
  90     public int getPosition() {
  91         return positionInfo.getAbsolutePosition();
  92     }
  93
  94     /**
  95      * Returns relative position for menu item.
  96      *
  97      * @return relative position
  98      */
  99     public PlacementStyle getPlacementStyle() {
 100         return positionInfo.getRelativePosition();
 101     }
 102
 103     /**
 104      * Returns information about relative and/or absolute position.
 105      *
 106      * @return information about relative and/or absolute position
 107      */
 108     public PositionInfo getPositionInfo() {
 109         return positionInfo;
 110     }
 111
 112     /**
 113      * Holds the absolute and/or relative position information.
 114      */
 115     public static final class PositionInfo{
 116
 117         /**
 118          * If position > 0 -> then use position (absolute positioning), else use placementStyle (relative positioning)
 119          */
 120         private int position = -1;
 121
 122         /**
 123          * Relative positioning.
 124          */
 125         private PlacementStyle placementStyle = PlacementStyle.LAST;
 126
 127         /**
 128          * Returns absolute positioning information.
 129          *
 130          * @return absolute positioning information
 131          */
 132         public int getAbsolutePosition() {
 133             return position;
 134         }
 135
 136         /**
 137          * Returns relative positioning information.
 138          *
 139          * @return relative positioning information
 140          */
 141         public PlacementStyle getRelativePosition() {
 142             return placementStyle;
 143         }
 144
 145         /**
 146          * Sets absolute positioning information.
 147          *
 148          * @param position is the new absolute position
 149          */
 150         public void setPosition(final int position) {
 151             this.position = position;
 152         }
 153
 154         /**
 155          * Sets relative positioning information.
 156          *
 157          * @param placementStyle is the new relative position
 158          */
 159         public void setRelativePosition(final PlacementStyle placementStyle) {
 160             this.placementStyle = placementStyle;
 161         }
 162     }
 163 }