ShippingChargesOverrideDialog

java.lang.Object
- org.eclipse.jface.window.Window
- - org.eclipse.jface.dialogs.Dialog
  - - org.eclipse.jface.dialogs.TrayDialog
    - - org.eclipse.jface.dialogs.TitleAreaDialog
      - com.ibm.commerce.telesales.ui.dialogs.TitleAreaDialog
        
        com.ibm.commerce.telesales.ui.impl.dialogs.shippingchargesoverride.ShippingChargesOverrideDialog

All Implemented Interfaces:

IDialog, java.util.EventListener, org.eclipse.jface.window.IShellProvider, org.eclipse.swt.events.SelectionListener, org.eclipse.swt.internal.SWTEventListener, org.eclipse.swt.widgets.Listener
```
public class ShippingChargesOverrideDialog
extends TitleAreaDialog
implements org.eclipse.swt.widgets.Listener, org.eclipse.swt.events.SelectionListener
```
ShippingChargesOverrideDialog is a dialog that displays all shipping modes for the current order. This allows the user to specify charge Information for each of the ship modes.

Nested Class Summary
- Nested classes/interfaces inherited from class org.eclipse.jface.window.Window
  org.eclipse.jface.window.Window.IExceptionHandler

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM copyright notice field
- Fields inherited from class com.ibm.commerce.telesales.ui.dialogs.TitleAreaDialog
  data_
- Fields inherited from class org.eclipse.jface.dialogs.TitleAreaDialog
  DLG_IMG_TITLE_BANNER, DLG_IMG_TITLE_ERROR, INFO_MESSAGE, WARNING_MESSAGE
- Fields inherited from class org.eclipse.jface.dialogs.Dialog
  blockedHandler, buttonBar, DIALOG_DEFAULT_BOUNDS, DIALOG_PERSISTLOCATION, DIALOG_PERSISTSIZE, dialogArea, DLG_IMG_ERROR, DLG_IMG_HELP, DLG_IMG_INFO, DLG_IMG_MESSAGE_ERROR, DLG_IMG_MESSAGE_INFO, DLG_IMG_MESSAGE_WARNING, DLG_IMG_QUESTION, DLG_IMG_WARNING, ELLIPSIS
- Fields inherited from class org.eclipse.jface.window.Window
  CANCEL, OK
- Fields inherited from interface com.ibm.commerce.telesales.ui.dialogs.IDialog
  KEY_ADDRESSES, KEY_CHECKED_ITEMS, KEY_COMPARE_SELECTION, KEY_CONTACT_HISTORY_DISPLAY_SETTING, KEY_CONTRACT_ID, KEY_CONTRACT_PRICES, KEY_CUSTOMER, KEY_CUSTOMER_COMMENT, KEY_DELAY, KEY_DYNAMIC_KIT, KEY_ENABLE_FILTER, KEY_FOR_USER, KEY_INITIAL_SEARCH_RESULTS, KEY_INSTANT_ADDITION, KEY_INSTANT_CREATION, KEY_IS_ORDER_ITEM_LEVEL_CHARGES, KEY_ITEM, KEY_ITEMS, KEY_NEW_ORGANIZATION, KEY_NEW_PRESSED, KEY_ORDER, KEY_ORDER_BLOCK, KEY_ORDER_BLOCKS, KEY_ORDER_CHANGE_INFO, KEY_ORDER_CHANGEREASON_LIST, KEY_ORGANIZATION, KEY_ORGANIZATIONS, KEY_PASSWORD, KEY_PASSWORD_EXPIRED, KEY_PAYMENT, KEY_PAYMENT_METHODS, KEY_PRICE_LIST, KEY_PROCESS_SELECTION, KEY_PRODUCT, KEY_PRODUCT_ITEM, KEY_PROMOTION, KEY_PROMOTION_APPLIED, KEY_PROMOTION_APPLY_TYPE, KEY_QUOTE, KEY_QUOTE_EXPIRY, KEY_RETURN, KEY_RETURN_ITEM_SERIALNUMBERLIST, KEY_RETURN_RECEIPT_LIST, KEY_SALES_CONTAINER_LIST, KEY_SELECTED_ITEMS, KEY_SELECTION_ITEMS, KEY_SERVICE_REQUEST, KEY_SHIPPING_CARRIERS, KEY_SHIPPING_INSTRUCTIONS, KEY_STATUS_MESSAGE, KEY_STORE, KEY_STORE_IDENTIFIER, KEY_STORES_AVAILABLE, KEY_STORES_OPEN, KEY_SUPPRESS_OK_ACTION, KEY_TICKLER, KEY_TICKLER_ACTIONS_AVAILABLE, KEY_TICKLERS_SELECTED, KEY_TSR_AVAILABLE, KEY_UNPAID_BALANCE, KEY_USER_NAME, KEY_VIEW_REGISTRY

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` IBM copyright notice field

Constructor Summary

Constructors
Constructor and Description

ShippingChargesOverrideDialog()

Constructors
Constructor and Description
`ShippingChargesOverrideDialog()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addProposedModifyListeners()` This method instantiates 3 ShippingChargesOverrideDialogModifyListeners.
`protected void`	`addProposedVerifyListeners()` This method instantiates 3 ShippingChargesOverrideDialogVerifyListeners.
`protected boolean`	`applyPressed()` This method is called when the 'Apply' button is pressed.
`protected void`	`buttonPressed(int id)` Handles the 'Apply', 'Cancel', and 'OK' buttons here.
`void`	`configureShell(org.eclipse.swt.widgets.Shell newShell)` Configures the given shell with the following style `SWT.DIALOG_TRIM \| SWT.APPLICATION_MODAL \| SWT.RESIZE` in preparation for opening this window in it.
`protected boolean`	`continueToApply()` This method is called by the applyPressed() method and calls the overFloor method.
`protected void`	`createActualOriginalRow(org.eclipse.swt.widgets.Composite parent)` Creates the actual original row widgets.
`protected void`	`createAmountOffListColumn(org.eclipse.swt.widgets.Composite parent)` Instantiates the amount off list column's Label widget.
`void`	`createButtonsForButtonBar(org.eclipse.swt.widgets.Composite parent)` Creates the 'Details', 'Attributes', 'Ok' and 'Cancel' buttons.
`protected void`	`createCommentField(org.eclipse.swt.widgets.Composite parent)` Instantiates the comment Label and Text widgets.
`protected void`	`createCurrentRow(org.eclipse.swt.widgets.Composite parent)` Creates the current row widgets.
`org.eclipse.swt.widgets.Control`	`createDialogArea(org.eclipse.swt.widgets.Composite parent)` Creates and returns the contents of the upper part of the dialog (above the button bar).
`protected void`	`createDiscReasonCombo(org.eclipse.swt.widgets.Composite parent)` Instantiates the discount reason Label and list widgets, and adds listeners.
`protected void`	`createFloorRow(org.eclipse.swt.widgets.Composite parent)` Creates the floor row widgets.
`protected void`	`createGroup1(org.eclipse.swt.widgets.Composite parent)` Creates the lefthand group that will contain the table and the total.
`protected void`	`createGroup2(org.eclipse.swt.widgets.Composite parent)` Creates the righthand group that will contain the details on the shipping charge for the selected `shipmode`.
`protected void`	`createLastTsrField(org.eclipse.swt.widgets.Composite parent)` Instantiates the Label widgets displaying the last CSR to edit the shipping charge.
`protected void`	`createOriginalRow(org.eclipse.swt.widgets.Composite parent)` Creates the Original row widgets.
`protected void`	`createPercentOffListColumn(org.eclipse.swt.widgets.Composite parent)` Instantiates the percent off list column's Label widget.
`protected void`	`createPriceColumn(org.eclipse.swt.widgets.Composite parent)` Instantiates the price column's Label widget.
`protected void`	`createProposedAmountOff(org.eclipse.swt.widgets.Composite parent)` Creates the proposed amount off Text widget and adds listeners.
`protected void`	`createProposedPercentOff(org.eclipse.swt.widgets.Composite parent)` Instantiates the proposed percent off Text widget and adds listeners.
`protected void`	`createProposedPrice(org.eclipse.swt.widgets.Composite parent)` Creates the proposed price Text widget and adds listeners.
`protected void`	`createProposedRow(org.eclipse.swt.widgets.Composite parent)` Instantiates the Label widget for the proposed row and calls the methods to create the widgets for the proposed row.
`org.eclipse.swt.widgets.Control`	`createSeparator(org.eclipse.swt.widgets.Composite parent)` Adds a separator to the tab pane.
`protected void`	`createShippedCharge(org.eclipse.swt.widgets.Composite parent)` Creates the shipped charge label.
`protected void`	`createTableViewer(java.util.Vector tableInput)` This method associates a table viewer with the table widget and displays the given data.
`protected void`	`createTotal()` Creates the total, which consists of 2 label widgets; the description and the value.
`RequiredLabelComposite`	`getActualOriginalLabel()` Returns the `actual original prompt label`.
`org.eclipse.swt.widgets.Label`	`getActualOriginalPrice()` Returns the actual original price label.
`org.eclipse.swt.widgets.Label`	`getAmountOffLabel()` Returns the amount off prompt label.
`org.eclipse.swt.widgets.Button`	`getApplyButton()` Returns the apply button
`org.eclipse.swt.widgets.Button`	`getCancelButton()` Returns the cancel button.
`org.eclipse.swt.widgets.Text`	`getComment()` Returns the comment text field.
`RequiredLabelComposite`	`getCommentLabel()` Returns the `comment prompt label`.
`org.eclipse.swt.widgets.Label`	`getCurrentAmountOff()` Returns the current amount off label.
`RequiredLabelComposite`	`getCurrentLabel()` Returns the current prompt label.
`org.eclipse.swt.widgets.Label`	`getCurrentPercentOff()` Returns the current percent off label.
`org.eclipse.swt.widgets.Label`	`getCurrentPrice()` Returns the current price label.
`com.ibm.commerce.telesales.ui.impl.dialogs.shippingchargesoverride.ShipChargeInfo`	`getCurrentShipChargeInfo()` Returns the currently selected ShipChargeInfo object.
`protected java.lang.String`	`getCurrentTotal()` Sums up all of the shipping modes' charges.
`org.eclipse.swt.widgets.Label`	`getFloorAmountOff()` Returns the floor amount off label.
`RequiredLabelComposite`	`getFloorLabel()` Returns the `floor prompt label`.
`org.eclipse.swt.widgets.Label`	`getFloorPercentOff()` Returns the floor percent off label.
`org.eclipse.swt.widgets.Label`	`getFloorPrice()` Returns the floor price label.
`java.lang.String`	`getHelpContextId()` Retrieves the help context ID.
`org.eclipse.swt.widgets.Label`	`getLastTsrId()` Returns the TSR ID label.
`RequiredLabelComposite`	`getLastTSRLabel()` Returns the `last TSR prompt label`.
`org.eclipse.swt.widgets.Button`	`getOkButton()` Returns the OK button.
`RequiredLabelComposite`	`getOriginalLabel()` Returns the original prompt label.
`org.eclipse.swt.widgets.Label`	`getOriginalPrice()` Returns the original price label.
`protected java.lang.String[]`	`getOverrideReasonDescriptions()` Gets the list of override reasons for the current store.
`org.eclipse.swt.widgets.Label`	`getPendingItemChargeHeader()` Returns the `pending charge header prompt label`.
`org.eclipse.swt.widgets.Label`	`getPercentOffListLabel()` Returns the percent off list prompt label.
`org.eclipse.swt.widgets.Label`	`getPriceEmpty()` Return the `price empty label`.
`org.eclipse.swt.widgets.Label`	`getPriceLabel()` Returns the `price prompt label`.
`org.eclipse.swt.widgets.Text`	`getProposedAmountOff()` Returns the proposed amount off text field.
`RequiredLabelComposite`	`getProposedLabel()` Returns the `proposed prompt label`.
`org.eclipse.swt.widgets.Text`	`getProposedPercentOff()` Returns the proposed percent off text field.
`org.eclipse.swt.widgets.Text`	`getProposedPrice()` Returns the proposed price text field.
`org.eclipse.swt.widgets.Combo`	`getReasonCombo()` Gets the reason combo.
`RequiredLabelComposite`	`getReasonLabel()` Returns the `reason prompt label`.
`protected org.eclipse.swt.graphics.Color`	`getRequiredFieldForegroundColor()` Returns the foreground color for required fields' asterisk indicator.
`java.lang.Object`	`getResult()` Returns the output as a result of the dialog work.
`protected SalesContainer`	`getSales()` Returns the `SalesContainer` object that this class is using.
`org.eclipse.swt.widgets.Label`	`getShippedChargeLabel()` Returns the `shipped charge amount prompt label`.
`org.eclipse.swt.widgets.Table`	`getTable()` Returns the table.
`org.eclipse.jface.viewers.TableViewer`	`getTableViewer()` Returns the table viewer.
`org.eclipse.swt.widgets.Label`	`getTotalLabel()` Returns the total prompt label.
`org.eclipse.swt.widgets.Label`	`getTotalValue()` Returns the total value label.
`void`	`handleEvent(org.eclipse.swt.widgets.Event event)` Sent when an event that the receiver has registered for occurs.
`protected org.eclipse.swt.widgets.Composite`	`initComposite()` Create the composite as a child of the scroll composite.
`protected void`	`initialize()` Initialize the dialog.
`protected boolean`	`isValidValue()` Check if the new negotiated value is valid; less than or equal to the original cost
`protected void`	`makeTable()` Instantiates the Dialogs table widget.
`protected void`	`okPressed()`
`protected void`	`openErrorDialog()` Open an error dialog to let user know that the new negotiated value must be less than or equal to the original cost.
`protected java.util.Vector`	`overFloor()` Checks the list of shipping charges to see if any that the current CSR has modified has a percent off that exceeds the floor percent off.
`protected void`	`populateGroup1()` Populates the left side of the dialog and adds the table and total to their group widget.
`protected void`	`populateGroup2()` Populates the right side of the dialog; adds widgets that will display the shipping charges details for the shipping mode selected in the table.
`protected void`	`refreshComment()` Sets the comment text field for the current comment.
`void`	`refreshDisplay()` Refresh the dialog display.
`void`	`refreshProposedAmountOff()` Refresh the contents of the proposed amount off.
`void`	`refreshProposedPercentOff()` Refresh the contents of the proposed percent off.
`void`	`refreshProposedPrice()` Refresh the proposed price.
`protected void`	`refreshReason()` Sets the reason drop down to the current given reason.
`void`	`saveAmountOff()` Save the specified amount off.
`void`	`saveCost()` Save the specified cost.
`void`	`saveCurrentComment()` Save the specified comment.
`void`	`saveCurrentReason()` Save the currently selected reason.
`void`	`savePercentOff()` Save the specified percent off.
`protected void`	`setScroll(org.eclipse.swt.widgets.Composite composite)` Initialize the scroll composite.
`protected void`	`setToolTips()` Sets the tool tips for all the user editable fields (proposed price; proposed amount off; proposed percent off; discount reason; comment).
`protected void`	`showSelectedShipChargeInfo(com.ibm.commerce.telesales.ui.impl.dialogs.shippingchargesoverride.ShipChargeInfo selectedShipChargeInfo)` This method is called when there is a new table selection; it refreshes the rest of the dialog to display information about the current selection.
`protected void`	`turnListenersOff()` Calls the notifyListeners() method of the 3 text field members of this class with an event that has a Boolean data value set to false.
`protected void`	`turnListenersOn()` Calls the notifyListeners() method of the 3 text field members of this class with an event that has a Boolean data value set to true.
`void`	`widgetDefaultSelected(org.eclipse.swt.events.SelectionEvent event)` Sent when default selection occurs in the control.
`void`	`widgetSelected(org.eclipse.swt.events.SelectionEvent event)` Sent when selection occurs in the control.

Methods inherited from class com.ibm.commerce.telesales.ui.dialogs.TitleAreaDialog
createButtonBar, getData, setData

Methods inherited from class org.eclipse.jface.dialogs.TitleAreaDialog
createContents, getInitialSize, getTitleArea, getTitleImageLabel, setErrorMessage, setMessage, setMessage, setTitle, setTitleAreaColor, setTitleImage

Methods inherited from class org.eclipse.jface.dialogs.TrayDialog
close, closeTray, createHelpControl, getLayout, getTray, isDialogHelpAvailable, isHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable

Methods inherited from class org.eclipse.jface.dialogs.Dialog
applyDialogFont, cancelPressed, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getDialogArea, getDialogBoundsSettings, getDialogBoundsStrategy, getImage, getInitialLocation, getOKButton, initializeBounds, initializeDialogUnits, isResizable, setBlockedHandler, setButtonLayoutData, setButtonLayoutFormData, shortenText

Methods inherited from class org.eclipse.jface.window.Window
canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setParentShell, setReturnCode, setShellStyle, setWindowManager

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.telesales.ui.dialogs.IDialog
open

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    IBM copyright notice field
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ShippingChargesOverrideDialog
```
public ShippingChargesOverrideDialog()
```
- Method Detail
  - configureShell
```
public void configureShell(org.eclipse.swt.widgets.Shell newShell)
```
    Configures the given shell with the following style SWT.DIALOG_TRIM | SWT.APPLICATION_MODAL | SWT.RESIZE in preparation for opening this window in it.
    
    Overrides:
    
    configureShell in class org.eclipse.jface.window.Window
    
    Parameters:
    
    newShell - the shell
    
    See Also:
    
    Window.configureShell(org.eclipse.swt.widgets.Shell), IWorkbenchHelpSystem#setHelp(org.eclipse.swt.widgets.Control, java.lang.String), getHelpContextId()
  - getHelpContextId
```
public java.lang.String getHelpContextId()
```
    Retrieves the help context ID.
    
    Returns:
    
    The help context ID.
    
    See Also:
    
    ITelesalesHelpContextIds.SHIPPING_OVERRIDE_DIALOG
  - createDialogArea
```
public org.eclipse.swt.widgets.Control createDialogArea(org.eclipse.swt.widgets.Composite parent)
```
    Creates and returns the contents of the upper part of the dialog (above the button bar).
    
    Overrides:
    
    createDialogArea in class TitleAreaDialog
    
    Parameters:
    
    parent - the parent composite to contain the dialog area
    
    Returns:
    
    The dialog area control.
    
    See Also:
    
    Dialog.createDialogArea(org.eclipse.swt.widgets.Composite)
  - buttonPressed
```
protected void buttonPressed(int id)
```
    Handles the 'Apply', 'Cancel', and 'OK' buttons here. Also, any buttons that are subclasses of ShippingChargesOverrideDialog had defined in the createButtonsForButtonBar() method.
    
    Overrides:
    
    buttonPressed in class org.eclipse.jface.dialogs.Dialog
    
    See Also:
    
    Dialog.buttonPressed(int)
  - okPressed
```
protected void okPressed()
```
    Overrides:
    
    okPressed in class org.eclipse.jface.dialogs.Dialog
    
    See Also:
    
    Dialog.okPressed()
  - applyPressed
```
protected boolean applyPressed()
```
    This method is called when the 'Apply' button is pressed. Changes are applied locally (the GUI no longer has any 'dirty' markers). Not truly applied (to the server) until the dialog is closed. That is alt+f4,'OK' or 'Cancel' was pressed.
    
    Returns:
    
    Returns true if the changes were applied to the local shipping charges information.
  - continueToApply
```
protected boolean continueToApply()
```
    This method is called by the applyPressed() method and calls the overFloor method. If the overFloor method returns true this method warns the user to not apply the changes by hitting the 'cancel' button.
    
    Returns:
    
    Returns true if the changes should be applied; false otherwise.
  - isValidValue
```
protected boolean isValidValue()
```
    Check if the new negotiated value is valid; less than or equal to the original cost
    
    Returns:
    
    Return true if the entered value is less than or equal to 0, false otherwise
  - openErrorDialog
```
protected void openErrorDialog()
```
    Open an error dialog to let user know that the new negotiated value must be less than or equal to the original cost.
  - overFloor
```
protected java.util.Vector overFloor()
```
    Checks the list of shipping charges to see if any that the current CSR has modified has a percent off that exceeds the floor percent off. If there is, a Vector containing the shipmode descriptions is returned.
    
    Returns:
    
    Returns a Vector of ship mode descriptions that exceed the CSR's floor percent off limit.
  - getOverrideReasonDescriptions
```
protected java.lang.String[] getOverrideReasonDescriptions()
```
    Gets the list of override reasons for the current store.
    
    Returns:
    
    Returns a String array of the override reasons.
  - initComposite
```
protected org.eclipse.swt.widgets.Composite initComposite()
```
    Create the composite as a child of the scroll composite.
    
    Returns:
    
    the new composite
  - setScroll
```
protected void setScroll(org.eclipse.swt.widgets.Composite composite)
```
    Initialize the scroll composite.
    
    Parameters:
    
    composite - The scroll content composite
  - populateGroup2
```
protected void populateGroup2()
```
    Populates the right side of the dialog; adds widgets that will display the shipping charges details for the shipping mode selected in the table.
  - createShippedCharge
```
protected void createShippedCharge(org.eclipse.swt.widgets.Composite parent)
```
    Creates the shipped charge label.
    
    Parameters:
    
    parent - the parent composite.
  - addProposedVerifyListeners
```
protected void addProposedVerifyListeners()
```
    This method instantiates 3 ShippingChargesOverrideDialogVerifyListeners. It also adds them to verifyListeners that listens to the proposedAmountOff Text field, proposedPercentOff Text field, and the proposedPrice Text field.
  - addProposedModifyListeners
```
protected void addProposedModifyListeners()
```
    This method instantiates 3 ShippingChargesOverrideDialogModifyListeners. It also adds them to the modifyListeners listening to proposedAmountOff Text field, proposedPercentOff Text field, and the proposedPrice Text field.
  - createCommentField
```
protected void createCommentField(org.eclipse.swt.widgets.Composite parent)
```
    Instantiates the comment Label and Text widgets.
    
    Parameters:
    
    parent - The Composite off of which to hang the widgets
  - createPercentOffListColumn
```
protected void createPercentOffListColumn(org.eclipse.swt.widgets.Composite parent)
```
    Instantiates the percent off list column's Label widget.
    
    Parameters:
    
    parent - The Composite off of which to hang the widget
  - createAmountOffListColumn
```
protected void createAmountOffListColumn(org.eclipse.swt.widgets.Composite parent)
```
    Instantiates the amount off list column's Label widget.
    
    Parameters:
    
    parent - The Composite off of which to hang the widget
  - createPriceColumn
```
protected void createPriceColumn(org.eclipse.swt.widgets.Composite parent)
```
    Instantiates the price column's Label widget.
    
    Parameters:
    
    parent - The Composite off of which to hang the widget
  - createLastTsrField
```
protected void createLastTsrField(org.eclipse.swt.widgets.Composite parent)
```
    Instantiates the Label widgets displaying the last CSR to edit the shipping charge.
    
    Parameters:
    
    parent - The Composite off of which to hang the widgets
  - getRequiredFieldForegroundColor
```
protected org.eclipse.swt.graphics.Color getRequiredFieldForegroundColor()
```
    Returns the foreground color for required fields' asterisk indicator.
    Checks for high contrast mode being enabled.
    
    Returns:
    
    The foreground color.
  - createDiscReasonCombo
```
protected void createDiscReasonCombo(org.eclipse.swt.widgets.Composite parent)
```
    Instantiates the discount reason Label and list widgets, and adds listeners.
    
    Parameters:
    
    parent - The Composite off of which to hang the widgets
  - createProposedRow
```
protected void createProposedRow(org.eclipse.swt.widgets.Composite parent)
```
    Instantiates the Label widget for the proposed row and calls the methods to create the widgets for the proposed row.
    
    Parameters:
    
    parent - The Composite off of which to hang the widgets
  - createProposedPrice
```
protected void createProposedPrice(org.eclipse.swt.widgets.Composite parent)
```
    Creates the proposed price Text widget and adds listeners.
    
    Parameters:
    
    parent - The Composite off of which to hang the widget
  - createProposedAmountOff
```
protected void createProposedAmountOff(org.eclipse.swt.widgets.Composite parent)
```
    Creates the proposed amount off Text widget and adds listeners.
    
    Parameters:
    
    parent - The Composite off of which to hang the widget
  - createProposedPercentOff
```
protected void createProposedPercentOff(org.eclipse.swt.widgets.Composite parent)
```
    Instantiates the proposed percent off Text widget and adds listeners.
    
    Parameters:
    
    parent - The Composite off of which to hang the widget
  - createFloorRow
```
protected void createFloorRow(org.eclipse.swt.widgets.Composite parent)
```
    Creates the floor row widgets.
    
    Parameters:
    
    parent - The Composite off of which to hang widgets
  - createCurrentRow
```
protected void createCurrentRow(org.eclipse.swt.widgets.Composite parent)
```
    Creates the current row widgets.
    
    Parameters:
    
    parent - The Composite off of which to hang widgets
  - createActualOriginalRow
```
protected void createActualOriginalRow(org.eclipse.swt.widgets.Composite parent)
```
    Creates the actual original row widgets.
    
    Parameters:
    
    parent - The Composite off of which to hang the label widget
  - createOriginalRow
```
protected void createOriginalRow(org.eclipse.swt.widgets.Composite parent)
```
    Creates the Original row widgets. This is the current shipping charges row.
    
    Parameters:
    
    parent - The Composite off of which to hang the label widget
  - createGroup2
```
protected void createGroup2(org.eclipse.swt.widgets.Composite parent)
```
    Creates the righthand group that will contain the details on the shipping charge for the selected shipmode.
    
    Parameters:
    
    parent - The Composite off of which to hang the group widget
  - createGroup1
```
protected void createGroup1(org.eclipse.swt.widgets.Composite parent)
```
    Creates the lefthand group that will contain the table and the total.
    
    Parameters:
    
    parent - The Composite off of which to hang the group widget
  - createSeparator
```
public org.eclipse.swt.widgets.Control createSeparator(org.eclipse.swt.widgets.Composite parent)
```
    Adds a separator to the tab pane.
    This method adds a horizontal separator to the pane dividing the shipping charges and button bar.
    
    Subclasses may override.
    
    Parameters:
    
    parent - the composite
    
    Returns:
    
    Returns a Control that is a Label of type horizontal separator.
  - getSales
```
protected SalesContainer getSales()
```
    Returns the SalesContainer object that this class is using. The sales container may be order or quote.
    
    Returns:
    
    Returns the current sales container being used by this dialog.
  - populateGroup1
```
protected void populateGroup1()
```
    Populates the left side of the dialog and adds the table and total to their group widget. And also initializes the local data used to fill the table and associated data.
  - createTableViewer
```
protected void createTableViewer(java.util.Vector tableInput)
```
    This method associates a table viewer with the table widget and displays the given data.
    
    Parameters:
    
    tableInput - the data to display in the table widget
  - createTotal
```
protected void createTotal()
```
    Creates the total, which consists of 2 label widgets; the description and the value.
  - getOkButton
```
public org.eclipse.swt.widgets.Button getOkButton()
```
    Returns the OK button.
    
    Returns:
    
    returns the OK button.
  - getCancelButton
```
public org.eclipse.swt.widgets.Button getCancelButton()
```
    Returns the cancel button.
    
    Overrides:
    
    getCancelButton in class org.eclipse.jface.dialogs.Dialog
    
    Returns:
    
    the cancel button.
  - getApplyButton
```
public org.eclipse.swt.widgets.Button getApplyButton()
```
    Returns the apply button
    
    Returns:
    
    the apply button
  - getLastTSRLabel
```
public RequiredLabelComposite getLastTSRLabel()
```
    Returns the last TSR prompt label.
    
    Returns:
    
    The last TSR prompt label.
  - getFloorLabel
```
public RequiredLabelComposite getFloorLabel()
```
    Returns the floor prompt label.
    
    Returns:
    
    the prompt label label.
  - getProposedLabel
```
public RequiredLabelComposite getProposedLabel()
```
    Returns the proposed prompt label.
    
    Returns:
    
    the proposed prompt label.
  - getReasonLabel
```
public RequiredLabelComposite getReasonLabel()
```
    Returns the reason prompt label.
    
    Returns:
    
    the reason prompt label.
  - getActualOriginalLabel
```
public RequiredLabelComposite getActualOriginalLabel()
```
    Returns the actual original prompt label.
    
    Returns:
    
    the actual original prompt label.
  - getShippedChargeLabel
```
public org.eclipse.swt.widgets.Label getShippedChargeLabel()
```
    Returns the shipped charge amount prompt label.
    
    Returns:
    
    the shipped charge amount prompt label.
  - getPendingItemChargeHeader
```
public org.eclipse.swt.widgets.Label getPendingItemChargeHeader()
```
    Returns the pending charge header prompt label.
    
    Returns:
    
    the pending charge header prompt label.
  - getOriginalLabel
```
public RequiredLabelComposite getOriginalLabel()
```
    Returns the original prompt label.
    
    Returns:
    
    the original prompt label.
  - getCurrentLabel
```
public RequiredLabelComposite getCurrentLabel()
```
    Returns the current prompt label.
    
    Returns:
    
    the current prompt label.
  - getActualOriginalPrice
```
public org.eclipse.swt.widgets.Label getActualOriginalPrice()
```
    Returns the actual original price label.
    
    Returns:
    
    The actual original price label.
  - getOriginalPrice
```
public org.eclipse.swt.widgets.Label getOriginalPrice()
```
    Returns the original price label.
    
    Returns:
    
    The original price label.
  - getCurrentPrice
```
public org.eclipse.swt.widgets.Label getCurrentPrice()
```
    Returns the current price label.
    
    Returns:
    
    The current price label.
  - getLastTsrId
```
public org.eclipse.swt.widgets.Label getLastTsrId()
```
    Returns the TSR ID label.
    
    Returns:
    
    the TSR ID label
  - getFloorPrice
```
public org.eclipse.swt.widgets.Label getFloorPrice()
```
    Returns the floor price label.
    
    Returns:
    
    the floor price label
  - getCurrentAmountOff
```
public org.eclipse.swt.widgets.Label getCurrentAmountOff()
```
    Returns the current amount off label.
    
    Returns:
    
    the current amount off label.
  - getCurrentPercentOff
```
public org.eclipse.swt.widgets.Label getCurrentPercentOff()
```
    Returns the current percent off label.
    
    Returns:
    
    the current percent off label.
  - getFloorAmountOff
```
public org.eclipse.swt.widgets.Label getFloorAmountOff()
```
    Returns the floor amount off label.
    
    Returns:
    
    the floor amount off label.
  - getFloorPercentOff
```
public org.eclipse.swt.widgets.Label getFloorPercentOff()
```
    Returns the floor percent off label.
    
    Returns:
    
    the floor percent off label.
  - getAmountOffLabel
```
public org.eclipse.swt.widgets.Label getAmountOffLabel()
```
    Returns the amount off prompt label.
    
    Returns:
    
    the amount off prompt label.
  - getPercentOffListLabel
```
public org.eclipse.swt.widgets.Label getPercentOffListLabel()
```
    Returns the percent off list prompt label.
    
    Returns:
    
    the percent off list prompt label
  - getPriceEmpty
```
public org.eclipse.swt.widgets.Label getPriceEmpty()
```
    Return the price empty label.
    
    Returns:
    
    the price empty label.
  - getPriceLabel
```
public org.eclipse.swt.widgets.Label getPriceLabel()
```
    Returns the price prompt label.
    
    Returns:
    
    the price prompt label.
  - getCommentLabel
```
public RequiredLabelComposite getCommentLabel()
```
    Returns the comment prompt label.
    
    Returns:
    
    The comment prompt label.
  - getTotalLabel
```
public org.eclipse.swt.widgets.Label getTotalLabel()
```
    Returns the total prompt label.
    
    Returns:
    
    The total prompt label
  - getTotalValue
```
public org.eclipse.swt.widgets.Label getTotalValue()
```
    Returns the total value label.
    
    Returns:
    
    The total value label.
  - getProposedPrice
```
public org.eclipse.swt.widgets.Text getProposedPrice()
```
    Returns the proposed price text field.
    
    Returns:
    
    The proposed price text field
  - getProposedAmountOff
```
public org.eclipse.swt.widgets.Text getProposedAmountOff()
```
    Returns the proposed amount off text field.
    
    Returns:
    
    the proposed amount off text field
  - getProposedPercentOff
```
public org.eclipse.swt.widgets.Text getProposedPercentOff()
```
    Returns the proposed percent off text field.
    
    Returns:
    
    The proposed percent off text field.
  - getComment
```
public org.eclipse.swt.widgets.Text getComment()
```
    Returns the comment text field.
    
    Returns:
    
    the comment text field
  - getReasonCombo
```
public org.eclipse.swt.widgets.Combo getReasonCombo()
```
    Gets the reason combo.
    
    Returns:
    
    The reason combo
  - getTable
```
public org.eclipse.swt.widgets.Table getTable()
```
    Returns the table.
    
    Returns:
    
    the table
  - getTableViewer
```
public org.eclipse.jface.viewers.TableViewer getTableViewer()
```
    Returns the table viewer.
    
    Returns:
    
    the table viewer
  - getCurrentShipChargeInfo
```
public com.ibm.commerce.telesales.ui.impl.dialogs.shippingchargesoverride.ShipChargeInfo getCurrentShipChargeInfo()
```
    Returns the currently selected ShipChargeInfo object.
    
    Returns:
    
    the currently selected ShipChargeInfo object
  - getCurrentTotal
```
protected java.lang.String getCurrentTotal()
```
    Sums up all of the shipping modes' charges.
    
    Returns:
    
    Returns the current total of the charges for all shipping modes.
  - makeTable
```
protected void makeTable()
```
    Instantiates the Dialogs table widget.
  - showSelectedShipChargeInfo
```
protected void showSelectedShipChargeInfo(com.ibm.commerce.telesales.ui.impl.dialogs.shippingchargesoverride.ShipChargeInfo selectedShipChargeInfo)
```
    This method is called when there is a new table selection; it refreshes the rest of the dialog to display information about the current selection.
    
    Parameters:
    
    selectedShipChargeInfo - The selected object
  - refreshDisplay
```
public void refreshDisplay()
```
    Refresh the dialog display.
  - refreshProposedPrice
```
public void refreshProposedPrice()
```
    Refresh the proposed price.
  - refreshProposedAmountOff
```
public void refreshProposedAmountOff()
```
    Refresh the contents of the proposed amount off.
  - refreshProposedPercentOff
```
public void refreshProposedPercentOff()
```
    Refresh the contents of the proposed percent off.
  - refreshReason
```
protected void refreshReason()
```
    Sets the reason drop down to the current given reason. If null or the reason is not in the list, then the first reason is selected.
  - refreshComment
```
protected void refreshComment()
```
    Sets the comment text field for the current comment.
  - setToolTips
```
protected void setToolTips()
```
    Sets the tool tips for all the user editable fields (proposed price; proposed amount off; proposed percent off; discount reason; comment).
  - saveCurrentComment
```
public void saveCurrentComment()
```
    Save the specified comment.
  - saveCurrentReason
```
public void saveCurrentReason()
```
    Save the currently selected reason.
  - saveCost
```
public void saveCost()
```
    Save the specified cost.
  - saveAmountOff
```
public void saveAmountOff()
```
    Save the specified amount off.
  - savePercentOff
```
public void savePercentOff()
```
    Save the specified percent off.
  - createButtonsForButtonBar
```
public void createButtonsForButtonBar(org.eclipse.swt.widgets.Composite parent)
```
    Creates the 'Details', 'Attributes', 'Ok' and 'Cancel' buttons.
    
    Overrides:
    
    createButtonsForButtonBar in class org.eclipse.jface.dialogs.Dialog
    
    See Also:
    
    Dialog.createButtonsForButtonBar(org.eclipse.swt.widgets.Composite)
  - initialize
```
protected void initialize()
```
    Initialize the dialog.
  - handleEvent
```
public void handleEvent(org.eclipse.swt.widgets.Event event)
```
    Sent when an event that the receiver has registered for occurs.
    
    Specified by:
    
    handleEvent in interface org.eclipse.swt.widgets.Listener
    
    See Also:
    
    Listener.handleEvent(org.eclipse.swt.widgets.Event)
  - widgetSelected
```
public void widgetSelected(org.eclipse.swt.events.SelectionEvent event)
```
    Sent when selection occurs in the control.
    
    Specified by:
    
    widgetSelected in interface org.eclipse.swt.events.SelectionListener
    
    See Also:
    
    SelectionListener.widgetSelected(org.eclipse.swt.events.SelectionEvent)
  - widgetDefaultSelected
```
public void widgetDefaultSelected(org.eclipse.swt.events.SelectionEvent event)
```
    Sent when default selection occurs in the control.
    
    Specified by:
    
    widgetDefaultSelected in interface org.eclipse.swt.events.SelectionListener
    
    See Also:
    
    SelectionListener.widgetDefaultSelected(org.eclipse.swt.events.SelectionEvent)
  - getResult
```
public java.lang.Object getResult()
```
    Returns the output as a result of the dialog work.
    
    Specified by:
    
    getResult in interface IDialog
    
    Returns:
    
    output data
    
    See Also:
    
    IDialog.getResult()
  - turnListenersOff
```
protected void turnListenersOff()
```
    Calls the notifyListeners() method of the 3 text field members of this class with an event that has a Boolean data value set to false.
  - turnListenersOn
```
protected void turnListenersOn()
```
    Calls the notifyListeners() method of the 3 text field members of this class with an event that has a Boolean data value set to true.

Class ShippingChargesOverrideDialog

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jface.window.Window

Field Summary

Fields inherited from class com.ibm.commerce.telesales.ui.dialogs.TitleAreaDialog

Fields inherited from class org.eclipse.jface.dialogs.TitleAreaDialog

Fields inherited from class org.eclipse.jface.dialogs.Dialog

Fields inherited from class org.eclipse.jface.window.Window

Fields inherited from interface com.ibm.commerce.telesales.ui.dialogs.IDialog

Constructor Summary

Method Summary

Methods inherited from class com.ibm.commerce.telesales.ui.dialogs.TitleAreaDialog

Methods inherited from class org.eclipse.jface.dialogs.TitleAreaDialog

Methods inherited from class org.eclipse.jface.dialogs.TrayDialog

Methods inherited from class org.eclipse.jface.dialogs.Dialog

Methods inherited from class org.eclipse.jface.window.Window

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.commerce.telesales.ui.dialogs.IDialog

Field Detail

COPYRIGHT

Constructor Detail

ShippingChargesOverrideDialog

Method Detail

configureShell

getHelpContextId

createDialogArea

buttonPressed

okPressed

applyPressed

continueToApply

isValidValue

openErrorDialog

overFloor

getOverrideReasonDescriptions

initComposite

setScroll

populateGroup2

createShippedCharge

addProposedVerifyListeners

addProposedModifyListeners

createCommentField

createPercentOffListColumn

createAmountOffListColumn

createPriceColumn

createLastTsrField

getRequiredFieldForegroundColor

createDiscReasonCombo

createProposedRow

createProposedPrice

createProposedAmountOff

createProposedPercentOff

createFloorRow

createCurrentRow

createActualOriginalRow

createOriginalRow

createGroup2

createGroup1

createSeparator

getSales

populateGroup1

createTableViewer

createTotal

getOkButton

getCancelButton

getApplyButton

getLastTSRLabel

getFloorLabel

getProposedLabel

getReasonLabel

getActualOriginalLabel

getShippedChargeLabel

getPendingItemChargeHeader

getOriginalLabel

getCurrentLabel

getActualOriginalPrice

getOriginalPrice

getCurrentPrice

getLastTsrId

getFloorPrice

getCurrentAmountOff