Merge pull request #1 from beaucollins/menu-items

Menu Drawer Item refactor
wordpress-mobile · Apr 10, 2013 · 286c9f1 · 286c9f1
2 parents 4385ce0 + ea6c411
commit 286c9f1
Show file tree

Hide file tree

Showing 2 changed files with 390 additions and 264 deletions.
diff --git a/src/org/wordpress/android/ui/MenuDrawerItem.java b/src/org/wordpress/android/ui/MenuDrawerItem.java
@@ -0,0 +1,100 @@
+/**
+ * Represents a single item in the WPActionBarActivity's menu drawer. A MenuDrawerItem determines
+ * the label and icon to use in the menu, its presence in the menu, its selection state, and the
+ * action that happens when the item is selected.
+ */
+package org.wordpress.android.ui;
+
+import android.view.View;
+
+abstract class MenuDrawerItem {
+    /**
+     * Signifies that the item has no unique ID so should not be tracked in the last selected
+     * item preference.
+     */
+    public static int NO_ITEM_ID = -1;
+    /**
+     * Called when the menu item is selected.
+     */
+    abstract public void onSelectItem();
+    /**
+     * Determines if the menu item should be displayed in the menu. Default is always true.
+     */
+    public Boolean isVisible(){
+        return true;
+    };
+    /**
+     * Determines if the item is selected. Default is always false.
+     */
+    public Boolean isSelected(){
+        return false;
+    }
+    /**
+     * Method to allow the menu item to provide additional configuration to the view, default
+     * implementation does nothing.
+     */
+    public void onConfigureView(View view){};
+
+    // Resource id for the title string
+    protected int mTitle;
+    // Resource id for the icon drawable
+    protected int mIconRes;
+    // ID for the item for remembering which item was selected
+    private int mItemId;
+    /**
+     * Creates a MenuDrawerItem with the specific id, string resource id and drawable resource id
+     */
+    MenuDrawerItem(int itemId, int stringRes, int iconRes) {
+        mTitle = stringRes;
+        mIconRes = iconRes;
+        mItemId = itemId;
+    }
+    /**
+     * Creates a MenuDrawerItem with NO_ITEM_ID for it's id for items that shouldn't be remembered
+     * between application launches.
+     */
+    MenuDrawerItem(int stringRes, int iconRes){
+        this(NO_ITEM_ID, stringRes, iconRes);
+    }
+    /**
+     * Determines if the item has an id for remembering the last selected item
+     */
+    public boolean hasItemId(){
+        return getItemId() != NO_ITEM_ID;
+    }
+    /**
+     * Get's the item's unique ID
+     */
+    public int getItemId(){
+        return mItemId;
+    }
+    /**
+     * Returns the item's string representation (used by ArrayAdapter.getView)
+     */
+    public String toString(){
+        return "";
+    }
+    /**
+     * The resource id to use for the menu item's title
+     */
+    public int getTitleRes(){
+        return mTitle;
+    }
+    /**
+     * The resource id to use for the menu item's icon
+     */
+    public int getIconRes(){
+        return mIconRes;
+    }
+
+    public void selectItem(){
+        onSelectItem();
+    }
+    /**
+     * Allows the menu item to do additional manipulation to the view
+     */
+    public void configureView(View v){
+        onConfigureView(v);
+    }
+
+}