WebSVN – SmartDukaan – Diff – /trunk/CatalogDashboard/src/main/java/in/shop2020/catalog/dashboard/client/ItemActions.java

 import com.google.gwt.user.client.ui.RadioButton;
 import com.google.gwt.user.client.ui.ResizeComposite;
 import com.google.gwt.user.client.ui.VerticalPanel;
 import com.google.gwt.user.client.ui.Widget;
+/**
+ * Panel containing buttons for different actions on item.
+ * e.g. update item, add new item, change item status, mark/unmark risky, push prices to production etc.
+ * @author ankur
+ *
+ */
 public class ItemActions extends ResizeComposite{
     interface ItemActionsUiBinder extends UiBinder<Widget, ItemActions> {}
     private static ItemActionsUiBinder uiBinder = GWT.create(ItemActionsUiBinder.class);
     private final CatalogServiceAsync catalogService = GWT.create(CatalogService.class);
     @UiField Button markRisky, unmarkRisky;
     @UiField Button generateMasterSheet;
     public ItemActions(){
         initWidget(uiBinder.createAndBindUi(this));
+        //pushItemToProd.setEnabled(false);
+    }
     @UiHandler("updateItem")
     void updateItem(ClickEvent event) {
         itemDetails.updateItem();
+    }
+    /**
+     * creates a new form to fill up item details and displays the form.
+     * @param event
+     */
     @UiHandler("addItem")
     void addItem(ClickEvent event) {
         ItemForm itemForm = new ItemForm();
         itemForm.center();
         itemForm.show();
                 Window.alert("Error while marking item " + itemId + " IN PROCESS");
+            }
         });
+    }
+    /**
+     * Creates and pops up authentication dialog for push to production username and password
+     * @param event
+     */
     @UiHandler("pushItemToProd")
     void pushItemToProduction(ClickEvent event) {
         if(itemDetails.getItem() == null) {
             Window.alert("Please select an item to update");
             return;
     @UiHandler("generateMasterSheet")
     void generateMasterSheet(ClickEvent event)  {
         createDialog();
+    }
+    /**
+     * Creates and pops up  dialog box containing two options.
+     * 1) Handsets 2) Accessories
+     * Also creates submit and cancel buttons and add click event listeners to them.
+     * On submit button click, request is sent to <code>in.shop2020.catalog.dashboard.server.FileDownloadServlet<code>
+     */
     private void createDialog() {
         VerticalPanel vp = new VerticalPanel();
         final DialogBox db = new DialogBox();
         db.setText("Master Sheet Download");
         final RadioButton handsetsRB = new RadioButton("vendorCategory", "Handsets");
                 if(handsetsRB.getValue()) {
                     vendorCategory = "Handsets";
                 } else {
                     vendorCategory = "Accessories";
+                }
+                // Servlet mapping mastersheet/download is mapped to in.shop2020.catalog.dashboard.server.FileDownloadServlet
                 String link = GWT.getHostPageBaseURL() + "mastersheet/download?vendorCategory=" + vendorCategory;
                 Window.open(link, "_self", "Master Sheet Download");
                 db.hide();
+            }
         });
         db.center();
         db.setAnimationEnabled(true);
         db.show();
+    }
+    /**
+     * validates and then calls service method changeItemRiskyFlag to change risky flag.
+     * @param risky
+     */
     private void changeRiskyFlag(boolean risky) {
         Item item = itemDetails.getItem();
         if(item == null) {
             Window.alert("Please select an item to mark/unmark as risky");
             return;
+    }
     public void setItemDetails(ItemDetails itemDetails) {
         this.itemDetails = itemDetails;
+    }
+    /**
+     * Validate item status change.
+     * @param toStatus
+     * @return item Id if validation is successful else -1
+     */
     private long validateStatusChange(int toStatus) {
         final Item item = itemDetails.getItem();
         if(item == null) {
             Window.alert(getAlertString(toStatus)[0]);
             return -1;
             return -1;
+        }
         return item.getId();
+    }
+    /**
+     * @param toStatus
+     * @return messages to be show to the user if item status change validation fails.
+     *       <br>-first message will be shown if no item is selected in the list
+     *       <br>-second message is shown if validation for FromStatus to ToStatus fails.
+     */
     private String[] getAlertString(int toStatus) {
         String[] alertStr = {"", ""};
         switch(toStatus) {
         case Utils.PAUSED: {
             alertStr[0] = "Please select an ACTIVE item to mark PAUSED";

Subversion Repositories SmartDukaan

(root)/trunk/CatalogDashboard/src/main/java/in/shop2020/catalog/dashboard/client/ItemActions.java – Rev 2359 → 2427