java.lang.Object
- com.microstrategy.web.transform.AbstractTransform
- - com.microstrategy.web.transform.AbstractLayoutTransform
  - - com.microstrategy.web.app.transforms.AbstractAppTransform
    - - com.microstrategy.web.app.transforms.AddressTransform
      - com.microstrategy.web.app.transforms.AddressListTransform

All Implemented Interfaces:

AppTransform, Transform

Direct Known Subclasses:

AddressListFileTransform, AddressListPrintTransform, UserAddressListTransform
```
public class AddressListTransform
extends AddressTransform
```
This transform is used to list and edit Narrowcast Addresses. It also allows to add new addresses and set default addresses.

Since:

MicroStrategy Web 7.3.1 or earlier

Nested Class Summary
- Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
  AbstractAppTransform.Context

Field Summary

Fields
Modifier and Type	Field	Description
`protected int`	`_levelFlag`	Variable to hold the value of the `levelFlag` Formal Parameter
`protected int`	`_maxItemCount`	Variable to hold the value of the `maxItemCount` Formal Parameter
`FormalParameter`	`checkImage`	The name of the image used to indicate the default address.
`FormalParameter`	`confirmDelete`	Indicates whether to confirm or not before deleting an address.
`protected java.lang.String`	`cssContent`	Deprecated. This CSS is no longer required as we use new styles for this purpose rather than nested tables.
`protected java.lang.String`	`cssFooter`	Deprecated. This CSS is no longer required as we use new styles for this purpose rather than nested tables.
`protected java.lang.String`	`cssHeader`	Deprecated. This CSS is no longer required as we use new styles for this purpose rather than nested tables.
`protected java.lang.String`	`cssItem`	Variable to hold the CSS class for the each of the individual address items
`protected java.lang.String`	`cssSelectedItem`	Variable to hold the CSS class for the individual items of a selected address or for editing or a new address
`protected java.lang.String`	`cssTableHeader`	Variable to hold the CSS class for the headers of the listed addresses
`static java.lang.String`	`FP_CONFIRM_DELETE`	Constant for the name of the `confirmDelete` Formal Parameter.
`static java.lang.String`	`FP_IMG_CHECK`	Constant for the name of the `checkImage` Formal Parameter.
`static java.lang.String`	`FP_IMG_UPPER_LEFT`	Deprecated. This image is no longer required, the header of the preferences page is defined with css styles
`static java.lang.String`	`FP_IMG_UPPER_RIGHT`	Deprecated. This image is no longer required, the header of the preferences page is defined with css styles
`static java.lang.String`	`FP_LEVEL_FLAG`	Constant for the name of the `levelFlag` Formal Parameter.
`static java.lang.String`	`FP_MAX_ITEMS_COUNT`	Constant for the name of the `maxItemCount` Formal Parameter.
`static int`	`LEVEL_ADD`	LEVEL parameter that specifies to include a link to add new addresses
`static int`	`LEVEL_ALL`	LEVEL parameter that includes all LEVEL parameters.
`static int`	`LEVEL_COLUMN_HEADERS`	LEVEL parameter that specifies to include the column headers
`static int`	`LEVEL_DEVICE_NAME`	LEVEL parameter that specifies to include the address device name
`static int`	`LEVEL_DISPLAY_NAME`	LEVEL parameter that specifies to include the address display name
`static int`	`LEVEL_EDIT`	LEVEL parameter that specifies to include a link to edit the address.
`static int`	`LEVEL_OUTER_FRAME`	LEVEL parameter that specifies to include the address list within another frame This frame is the one used by other sections in Preferences page.
`static int`	`LEVEL_PHYSICAL_ADDRESS`	LEVEL parameter that specifies to include the address physical address
`static int`	`LEVEL_REMOVE`	LEVEL parameter that specifies to include a link to remove the address
`static int`	`LEVEL_SET_DEFAULT`	LEVEL parameter that specifies to include a link to set any of the addresses as default
`FormalParameter`	`levelFlag`	Specifies what information is displayed for each address.
`FormalParameter`	`maxItemCount`	Indicates how many addresses will be displayed in the address list.
`FormalParameter`	`upperLeftCornerImage`	Deprecated. This image is no longer required, the header of the preferences page is defined with css styles
`FormalParameter`	`upperRightCornerImage`	Deprecated. This image is no longer required, the header of the preferences page is defined with css styles

Fields inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
_bean, _componentBlock, _cssPrefix, _imgBlank, _imgWait, _selfOutput, _subOutput, appliesTo, CLASS_INPUT, CLASS_MESSAGE, contextMenus, cssFile, cssPrefix, debugErrorFlags, debugFlags, dragMode, extraInput, extraUrl, FP_APPLIES_TO, FP_CONTEXT_MENUS, FP_CSS_ERROR_MESSAGE, FP_CSS_ERROR_TITLE, FP_CSS_FILE, FP_CSS_PREFIX, FP_DEBUG_ERROR_FLAGS, FP_DEBUG_FLAGS, FP_DRAG_MODE, FP_EXTRA_INPUT, FP_EXTRA_URL, FP_HEIGHT, FP_IFRAME_ENABLED, FP_IMG_WAIT, FP_INITIAL_INDENT, FP_ORIENTATION, FP_ORIENTATIONS_ALLOWED, FP_PARTIAL_IFRAME_UPDATE, FP_PROCESSING_BUTTONS_FLAGS, FP_PROCESSING_INFO_FLAGS, FP_RESIZE_LEVEL, FP_SCRIPT_CLASS, FP_TYPE, FP_USE_DHTML, FP_WIDTH, globalCssErrorMessage, globalCssErrorTitle, height, iframeEnabled, imgWait, indent, initialIndent, isDHTML, orientation, orientationsAllowed, partialIframeUpdate, PROCESSING_BUTTONS_ALL, PROCESSING_BUTTONS_CANCEL, PROCESSING_BUTTONS_HISTORY_LIST, PROCESSING_BUTTONS_REFRESH, PROCESSING_BUTTONS_VIEW_DETAILS, PROCESSING_INFO_ALL, PROCESSING_INFO_DESCRIPTION, PROCESSING_INFO_LAST_UPDATE, PROCESSING_INFO_NAME, PROCESSING_INFO_NONE, PROCESSING_INFO_STATUS, processingButtonsFlags, processingInfoFlags, RESIZE_ALL, RESIZE_HORIZONTAL, RESIZE_NONE, RESIZE_VERTICAL, resizeLevel, scriptClass, scriptEndTagEncoder, type, useDHTML, width

Constructor Summary

Constructors
Constructor Description

AddressListTransform()
Default no argument constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`addAttributesToLinkAnchor(Tag anchor)`
`protected boolean`	`canDisplayNewAddressLink()`
`boolean`	`checkLevel(int column)`	Checks the level flag with the level of a column to decide if we want to render a particular column.
`protected AnchorTag`	`generateAnchor(WebEvent event)`	Overwrites parent method by testing if anchor should be enabled for iframe environment
`protected SimpleList`	`getAddresses()`
`protected AddressListBean`	`getAddressListBean()`	Returns the list of supported devices for email addresses.
`protected SimpleList`	`getAvailableDevices()`	Returns the list of supported devices for email addresses.
`java.lang.String`	`getDescription()`	Returns the description of this transform.
`InputTag`	`getEditDisplayNameField(WebSubscriptionAddress address)`
`InputTag`	`getEditPhysicalAddressInput(WebSubscriptionAddress address)`
`WebEvent`	`getEventAdd()`	Returns the event to add a new address.
`WebEvent`	`getEventCancel()`	Returns the event to cancel editing or saving an address.
`WebEvent`	`getEventEdit(WebSubscriptionAddress address)`	Returns the event to edit an existing address.
`WebEvent`	`getEventRemove(WebSubscriptionAddress address)`	Returns the event to delete an existing address.
`WebEvent`	`getEventSave()`	Returns the event to save the address currently being editing
`WebEvent`	`getEventSetDefault()`	Returns the event to change the current default address.
`protected java.lang.String`	`getSelectedDeviceId(WebSubscriptionAddress address)`
`java.lang.Class`	`getSupportedBeanType()`	Returns the supported bean type for the transform.
`java.lang.String`	`getTitle()`	Retrieves the Title for the dialog.
`void`	`initializeCss()`	Initialize the css classes to be used by this transform.
`void`	`initializeImages()`	Initialize the images to be used by this transform.
`void`	`initializeTransform(Transformable data)`	This method initialize the private and protected fields of the transform.
`protected boolean`	`isAddressInEditMode(WebSubscriptionAddress address)`
`protected boolean`	`isEditMode()`
`protected boolean`	`isNewAddress(WebSubscriptionAddress address, SimpleList addresses)`
`protected boolean`	`isNewAvailable()`
`void`	`renderAddress(MarkupOutput out, WebSubscriptionAddress address, boolean edit)`	Renders a single address.
`void`	`renderAddress(MarkupOutput out, WebSubscriptionAddress address, boolean edit, int bandOn)`	overloaded version - to add banding effect and remove deprecated code Renders a single address.
`protected void`	`renderAddressesTable(MarkupOutput out)`
`protected boolean`	`renderCancelInputButton(MarkupOutput out)`
`void`	`renderColgroups(MarkupOutput out)`	Renders all column headers for the address list.
`protected boolean`	`renderDeleteLink(MarkupOutput out, WebSubscriptionAddress address)`
`void`	`renderDeviceField(MarkupOutput out, WebSubscriptionAddress address, boolean edit)`
`void`	`renderDeviceInfo(MarkupOutput out, WebSubscriptionAddress address, boolean edit)`	Renders the device column of an address.
`void`	`renderDisplayNameField(MarkupOutput out, WebSubscriptionAddress address, boolean edit)`
`void`	`renderDisplayNameInfo(MarkupOutput out, WebSubscriptionAddress address, boolean edit)`	Renders the address name column of an address.
`void`	`renderEditInfo(MarkupOutput out, WebSubscriptionAddress address, boolean edit)`	Renders the edit/remove column of an address.
`protected boolean`	`renderEditLink(MarkupOutput out, WebSubscriptionAddress address)`
`void`	`renderEmptyAddress(MarkupOutput out)`	Renders an empty address when there is addresses available for that delivery mode
`void`	`renderEmtpyList(MarkupOutput out)`	Renders an empty list of addresses.
`void`	`renderFormEnd(MarkupOutput out)`	Renders the FORM end tag.
`void`	`renderFormStart(MarkupOutput out)`	Renders the FORM start tag.
`void`	`renderHeader(MarkupOutput out, int column)`	Renders a single column header for the Address List.
`protected void`	`renderHeaderContent(MarkupOutput out, int column)`
`void`	`renderHeaders(MarkupOutput out)`	Renders all column headers for the address list.
`void`	`renderImage(MarkupOutput out, java.lang.String image)`	Renders an image in the transform.
`void`	`renderList(MarkupOutput out, SimpleList list)`	Renders a non-empty list of addresses.
`protected void`	`renderNewLink(MarkupOutput out)`
`void`	`renderPhysicalAddressField(MarkupOutput out, WebSubscriptionAddress address, boolean edit)`
`void`	`renderPhysicalAddressInfo(MarkupOutput out, WebSubscriptionAddress address, boolean edit)`	Renders the physical address column of an address.
`protected boolean`	`renderSaveButton(MarkupOutput out)`
`protected void`	`renderSetDefaultButton(MarkupOutput out)`
`void`	`renderSetDefaultField(MarkupOutput out, WebSubscriptionAddress address, boolean edit)`
`void`	`renderSetDefaultInfo(MarkupOutput out, WebSubscriptionAddress address, boolean edit)`	Renders the default column of an address.
`protected void`	`setAddresses(SimpleList addresses)`
`protected void`	`transformBody(MarkupOutput out)`	This is called to generate the main body of the Address List dialog.
`protected void`	`transformFooter(MarkupOutput out)`	Generates the Footer of the Address List dialog.
`void`	`transformForRequestInError(MarkupOutput out)`	Transform when the status is `In Error`.
`void`	`transformForRequestNotInited(MarkupOutput out)`	Transform when the status is `Not initialized`.
`void`	`transformForRequestSuccessful(MarkupOutput out)`	Generates the graphical output for the AddressListBean when the bean is succesfull.
`void`	`transformForRequestWaitingForUserInput(MarkupOutput out)`	Transform when the status is `WaitingForUserInputessful`.
`protected void`	`transformHeader(MarkupOutput out)`	Generates the Header of the Address List dialog.

Methods inherited from class com.microstrategy.web.app.transforms.AddressTransform
getCancelEvent

Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getBeanPath, getBoneId, getCancelEvent, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorMessage, getErrorTitle, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getID, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestProcessing

Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform
getLayoutDefinition, setLayoutDefinition, transformUsingLayout

Methods inherited from class com.microstrategy.web.transform.AbstractTransform
addFormalParam, canTransform, getEvents, getFormalParams, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated, supports, supports

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

Methods inherited from interface com.microstrategy.web.transform.Transform
canTransform, getFormalParams, getPreview, isPreviewAvailable, isResolved, supports, supports

- Field Detail
  - cssHeader
```
@Deprecated
protected java.lang.String cssHeader
```
    Deprecated.
    This CSS is no longer required as we use new styles for this purpose rather than nested tables.
    
    Variable to hold the CSS class for the header cells of the outer table for rendering addresses
  - cssContent
```
@Deprecated
protected java.lang.String cssContent
```
    Deprecated.
    This CSS is no longer required as we use new styles for this purpose rather than nested tables.
    
    Variable to hold the CSS class for the content cells of the outer table for rendering addresses
  - cssFooter
```
@Deprecated
protected java.lang.String cssFooter
```
    Deprecated.
    This CSS is no longer required as we use new styles for this purpose rather than nested tables.
    
    Variable to hold the CSS class for the footer cells of the outer table for rendering addresses
  - cssTableHeader
```
protected java.lang.String cssTableHeader
```
    Variable to hold the CSS class for the headers of the listed addresses
  - cssItem
```
protected java.lang.String cssItem
```
    Variable to hold the CSS class for the each of the individual address items
  - cssSelectedItem
```
protected java.lang.String cssSelectedItem
```
    Variable to hold the CSS class for the individual items of a selected address or for editing or a new address
  - LEVEL_DISPLAY_NAME
```
public static final int LEVEL_DISPLAY_NAME
```
    LEVEL parameter that specifies to include the address display name
    
    See Also:
    
    Constant Field Values
  - LEVEL_PHYSICAL_ADDRESS
```
public static final int LEVEL_PHYSICAL_ADDRESS
```
    LEVEL parameter that specifies to include the address physical address
    
    See Also:
    
    Constant Field Values
  - LEVEL_DEVICE_NAME
```
public static final int LEVEL_DEVICE_NAME
```
    LEVEL parameter that specifies to include the address device name
    
    See Also:
    
    Constant Field Values
  - LEVEL_REMOVE
```
public static final int LEVEL_REMOVE
```
    LEVEL parameter that specifies to include a link to remove the address
    
    See Also:
    
    Constant Field Values
  - LEVEL_EDIT
```
public static final int LEVEL_EDIT
```
    LEVEL parameter that specifies to include a link to edit the address.
    
    See Also:
    
    Constant Field Values
  - LEVEL_ADD
```
public static final int LEVEL_ADD
```
    LEVEL parameter that specifies to include a link to add new addresses
    
    See Also:
    
    Constant Field Values
  - LEVEL_SET_DEFAULT
```
public static final int LEVEL_SET_DEFAULT
```
    LEVEL parameter that specifies to include a link to set any of the addresses as default
    
    See Also:
    
    Constant Field Values
  - LEVEL_COLUMN_HEADERS
```
public static final int LEVEL_COLUMN_HEADERS
```
    LEVEL parameter that specifies to include the column headers
    
    See Also:
    
    Constant Field Values
  - LEVEL_OUTER_FRAME
```
public static final int LEVEL_OUTER_FRAME
```
    LEVEL parameter that specifies to include the address list within another frame This frame is the one used by other sections in Preferences page.
    
    See Also:
    
    Constant Field Values
  - LEVEL_ALL
```
public static final int LEVEL_ALL
```
    LEVEL parameter that includes all LEVEL parameters.
    
    See Also:
    
    Constant Field Values
  - FP_IMG_CHECK
```
public static final java.lang.String FP_IMG_CHECK
```
    Constant for the name of the checkImage Formal Parameter.
    
    See Also:
    
    checkImage, Constant Field Values
  - FP_IMG_UPPER_LEFT
```
@Deprecated
public static final java.lang.String FP_IMG_UPPER_LEFT
```
    Deprecated.
    This image is no longer required, the header of the preferences page is defined with css styles
    
    Constant for the name of the upperLeftCornerImage Formal Parameter.
    
    See Also:
    
    upperLeftCornerImage, Constant Field Values
  - FP_IMG_UPPER_RIGHT
```
@Deprecated
public static final java.lang.String FP_IMG_UPPER_RIGHT
```
    Deprecated.
    This image is no longer required, the header of the preferences page is defined with css styles
    
    Constant for the name of the upperRightCornerImage Formal Parameter.
    
    See Also:
    
    upperRightCornerImage, Constant Field Values
  - FP_LEVEL_FLAG
```
public static final java.lang.String FP_LEVEL_FLAG
```
    Constant for the name of the levelFlag Formal Parameter.
    
    See Also:
    
    levelFlag, Constant Field Values
  - FP_MAX_ITEMS_COUNT
```
public static final java.lang.String FP_MAX_ITEMS_COUNT
```
    Constant for the name of the maxItemCount Formal Parameter.
    
    See Also:
    
    maxItemCount, Constant Field Values
  - FP_CONFIRM_DELETE
```
public static final java.lang.String FP_CONFIRM_DELETE
```
    Constant for the name of the confirmDelete Formal Parameter.
    
    See Also:
    
    confirmDelete, Constant Field Values
  - checkImage
```
public FormalParameter checkImage
```
    The name of the image used to indicate the default address.
    When editing an address or when adding a new address we use this image to indicate the default address among the list of addresses.
    Usage:
    "Check.gif"
  - upperLeftCornerImage
```
@Deprecated
public FormalParameter upperLeftCornerImage
```
    Deprecated.
    This image is no longer required, the header of the preferences page is defined with css styles
    
    The name of the image used for rendering the upper left corner of the Address List widget.
  - upperRightCornerImage
```
@Deprecated
public FormalParameter upperRightCornerImage
```
    Deprecated.
    This image is no longer required, the header of the preferences page is defined with css styles
    
    The name of the image used for rendering the upper right corner of the Address List widget.
  - levelFlag
```
public FormalParameter levelFlag
```
    Specifies what information is displayed for each address.
    The information may include address name, device name, edit link, delete link and other information. Multiple fields may be displayed at the same time. Which fields to show is indicated by a bitwise flag.
    Allowed Values:
    
    Display Name = 1
    
    Physical Address = 2
    
    Device Name = 4
    
    Delete Link = 16
    
    Edit Link = 32
    
    Add Link = 64
    
    Set Default Address = 128
    
    Show column headers = 256
    
    Show address list with in the outer preferences frame = 512
    
    Show every thing = 65535
    
    Usage:
    For example, if you want to specify display name and device name only, then you would specify (1 + 4 = 5).
  - _levelFlag
```
protected int _levelFlag
```
    Variable to hold the value of the levelFlag Formal Parameter
    
    See Also:
    
    levelFlag
  - maxItemCount
```
public FormalParameter maxItemCount
```
    Indicates how many addresses will be displayed in the address list.
    This value will determine the number of addresses rendered in the address list. Any negative value would display the entire list of addresses.
  - _maxItemCount
```
protected int _maxItemCount
```
    Variable to hold the value of the maxItemCount Formal Parameter
    
    See Also:
    
    maxItemCount
  - confirmDelete
```
public FormalParameter confirmDelete
```
    Indicates whether to confirm or not before deleting an address.
    Setting this value to true will render a address deletion confirmation page before deleting the address. If confirming is set to true, we would use the event from the servlet to go to the confirmation page. If not, we will just ask the AddressListBean to remove the address.
- Constructor Detail
  - AddressListTransform
```
public AddressListTransform()
```
    Default no argument constructor. Initialize formal parameters.
- Method Detail
  - getDescription
```
public java.lang.String getDescription()
```
    Returns the description of this transform.
    This is used in the style catalog editor.
    
    Returns:
    
    The description of this transform.
  - initializeTransform
```
public void initializeTransform(Transformable data)
```
    This method initialize the private and protected fields of the transform.
    It also invokes the initializeTransform method of the parent. It retrieves the list of addresses from the bean.
    
    Specified by:
    
    initializeTransform in interface AppTransform
    
    Overrides:
    
    initializeTransform in class AbstractAppTransform
    
    Parameters:
    
    data - The bean to transform
  - getAddresses
```
protected SimpleList getAddresses()
```
    Since:
    
    MicroStrategy Web 9.0.0
  - setAddresses
```
protected void setAddresses(SimpleList addresses)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - transformForRequestWaitingForUserInput
```
public void transformForRequestWaitingForUserInput(MarkupOutput out)
```
    Transform when the status is WaitingForUserInputessful.
    Overwrites by showing the Preferences form. It paints the address list form.
    
    Overrides:
    
    transformForRequestWaitingForUserInput in class AbstractAppTransform
    
    Parameters:
    
    out - the transform's output
    
    See Also:
    
    AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
  - transformForRequestInError
```
public void transformForRequestInError(MarkupOutput out)
```
    Transform when the status is In Error.
    Overwrites transformForRequestInError by showing a "The email subscriptions feature is currently unavailable" message.
    
    Overrides:
    
    transformForRequestInError in class AbstractAppTransform
    
    Parameters:
    
    out - the transform's output
    
    See Also:
    
    AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
  - transformForRequestNotInited
```
public void transformForRequestNotInited(MarkupOutput out)
```
    Transform when the status is Not initialized.
    It invokes the transformForRequestNotInited method on the parent and then invokes the transformForRequestWaitingForUserInput method on itself.
    
    Overrides:
    
    transformForRequestNotInited in class AbstractAppTransform
    
    Parameters:
    
    out - Output by this transform
    
    See Also:
    
    AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
  - transformForRequestSuccessful
```
public void transformForRequestSuccessful(MarkupOutput out)
```
    Generates the graphical output for the AddressListBean when the bean is succesfull. It calls transformForRequestWaitingForUserInput so the user might edit or view Address Values.
    
    Specified by:
    
    transformForRequestSuccessful in class AbstractAppTransform
    
    Parameters:
    
    out - The transform's output.
    
    See Also:
    
    AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
  - transformHeader
```
protected void transformHeader(MarkupOutput out)
```
    Generates the Header of the Address List dialog.
    
    Parameters:
    
    out - The transform's output.
  - getTitle
```
public java.lang.String getTitle()
```
    Retrieves the Title for the dialog.
    
    Returns:
    
    The Title for the dialog. By default it is the current group, "Email Addresses" in this case.
  - transformFooter
```
protected void transformFooter(MarkupOutput out)
```
    Generates the Footer of the Address List dialog.
    
    Parameters:
    
    out - The transform's output.
  - renderSetDefaultButton
```
protected void renderSetDefaultButton(MarkupOutput out)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - isNewAvailable
```
protected boolean isNewAvailable()
```
    Since:
    
    MicroStrategy Web 9.0.0
  - isEditMode
```
protected boolean isEditMode()
```
    Since:
    
    MicroStrategy Web 9.0.0
  - renderAddressesTable
```
protected void renderAddressesTable(MarkupOutput out)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - canDisplayNewAddressLink
```
protected boolean canDisplayNewAddressLink()
```
    Since:
    
    MicroStrategy Web 9.0.0
  - transformBody
```
protected void transformBody(MarkupOutput out)
```
    This is called to generate the main body of the Address List dialog.
    This method calls other methods to render the entire address list and links for edit, delete, add and set default address.
    
    Parameters:
    
    out - The transform's output.
  - renderNewLink
```
protected void renderNewLink(MarkupOutput out)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - generateAnchor
```
protected AnchorTag generateAnchor(WebEvent event)
```
    Overwrites parent method by testing if anchor should be enabled for iframe environment
    
    Overrides:
    
    generateAnchor in class AbstractAppTransform
    
    Parameters:
    
    event - WebEvent
    
    Returns:
    
    AnchorTag
    
    Since:
    
    MicroStrategy Web 8.0.0
  - isNewAddress
```
protected boolean isNewAddress(WebSubscriptionAddress address,
                               SimpleList addresses)
```
  - renderColgroups
```
public void renderColgroups(MarkupOutput out)
```
    Renders all column headers for the address list.
    
    Parameters:
    
    out - The transform's output.
    
    Since:
    
    MicroStrategy Web 9.0.0
  - renderHeaders
```
public void renderHeaders(MarkupOutput out)
```
    Renders all column headers for the address list.
    
    Parameters:
    
    out - The transform's output.
  - renderHeader
```
public void renderHeader(MarkupOutput out,
                         int column)
```
    Renders a single column header for the Address List. Calls renderHeaderContent(com.microstrategy.web.beans.MarkupOutput, int) for displaying the text and other content related with the header.
    
    Parameters:
    
    out - The transform's output.
    
    column - The column to render
  - renderHeaderContent
```
protected void renderHeaderContent(MarkupOutput out,
                                   int column)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - renderEmtpyList
```
public void renderEmtpyList(MarkupOutput out)
```
    Renders an empty list of addresses.
    It would render the form to create a new address if there are no addresses in the list. This new address is also set as the derfault address.
    
    Parameters:
    
    out - The transform's output.
  - renderEmptyAddress
```
public void renderEmptyAddress(MarkupOutput out)
```
    Renders an empty address when there is addresses available for that delivery mode
    
    Parameters:
    
    out -
    
    Throws:
    
    WebBeanException
    
    Since:
    
    MicroStrategy Web 8.0.1
  - renderList
```
public void renderList(MarkupOutput out,
                       SimpleList list)
```
    Renders a non-empty list of addresses.
    
    Parameters:
    
    out - The transform's output.
    
    list - The list of addresses to render
  - isAddressInEditMode
```
protected boolean isAddressInEditMode(WebSubscriptionAddress address)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - renderAddress
```
public void renderAddress(MarkupOutput out,
                          WebSubscriptionAddress address,
                          boolean edit)
```
    Renders a single address.
    
    Parameters:
    
    out - The transform's output.
    
    address - The address to render
    
    edit - Indicates whether to show the address in edit mode.
  - renderAddress
```
public void renderAddress(MarkupOutput out,
                          WebSubscriptionAddress address,
                          boolean edit,
                          int bandOn)
```
    overloaded version - to add banding effect and remove deprecated code Renders a single address.
    
    Parameters:
    
    out - The transform's output.
    
    address - The address to render
    
    edit - Indicates whether to show the address in edit mode.
    
    bandOn - flat to indicate where set bandOn effect to this TR 0 - off; 1 - on
    
    Since:
    
    MicroStrategy Web 9.0.0
  - renderSetDefaultInfo
```
public void renderSetDefaultInfo(MarkupOutput out,
                                 WebSubscriptionAddress address,
                                 boolean edit)
```
    Renders the default column of an address.
    In the list mode it would render the radio button and in the edit mode it would render the check box next to the defaul address.
    
    Parameters:
    
    out - The transform's output.
    
    address - the address to render
    
    edit - indicates whether to show the address in edit mode.
  - renderSetDefaultField
```
public void renderSetDefaultField(MarkupOutput out,
                                  WebSubscriptionAddress address,
                                  boolean edit)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - renderDisplayNameInfo
```
public void renderDisplayNameInfo(MarkupOutput out,
                                  WebSubscriptionAddress address,
                                  boolean edit)
```
    Renders the address name column of an address.
    
    Parameters:
    
    out - The transform's output.
    
    address - The address to render
    
    edit - Indicates whether to show the address in edit mode.
  - renderDisplayNameField
```
public void renderDisplayNameField(MarkupOutput out,
                                   WebSubscriptionAddress address,
                                   boolean edit)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - getEditDisplayNameField
```
public InputTag getEditDisplayNameField(WebSubscriptionAddress address)
```
  - renderPhysicalAddressInfo
```
public void renderPhysicalAddressInfo(MarkupOutput out,
                                      WebSubscriptionAddress address,
                                      boolean edit)
```
    Renders the physical address column of an address.
    
    Parameters:
    
    out - The transform's output.
    
    address - The address to render.
    
    edit - Indicates whether to show the address in edit mode.
  - renderPhysicalAddressField
```
public void renderPhysicalAddressField(MarkupOutput out,
                                       WebSubscriptionAddress address,
                                       boolean edit)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - getEditPhysicalAddressInput
```
public InputTag getEditPhysicalAddressInput(WebSubscriptionAddress address)
```
  - renderDeviceInfo
```
public void renderDeviceInfo(MarkupOutput out,
                             WebSubscriptionAddress address,
                             boolean edit)
```
    Renders the device column of an address.
    
    Parameters:
    
    out - The transform's output.
    
    address - The address to render.
    
    edit - Indicates whether to show the address in edit mode.
  - renderDeviceField
```
public void renderDeviceField(MarkupOutput out,
                              WebSubscriptionAddress address,
                              boolean edit)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - getSelectedDeviceId
```
protected java.lang.String getSelectedDeviceId(WebSubscriptionAddress address)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - renderSaveButton
```
protected boolean renderSaveButton(MarkupOutput out)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - renderCancelInputButton
```
protected boolean renderCancelInputButton(MarkupOutput out)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - renderEditLink
```
protected boolean renderEditLink(MarkupOutput out,
                                 WebSubscriptionAddress address)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - addAttributesToLinkAnchor
```
protected void addAttributesToLinkAnchor(Tag anchor)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - renderDeleteLink
```
protected boolean renderDeleteLink(MarkupOutput out,
                                   WebSubscriptionAddress address)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - renderEditInfo
```
public void renderEditInfo(MarkupOutput out,
                           WebSubscriptionAddress address,
                           boolean edit)
```
    Renders the edit/remove column of an address.
    It also renders the save/cancel buttons if editing an address.
    
    Parameters:
    
    out - The transform's output.
    
    address - the address to render.
    
    edit - Indicates whether to show the address in edit mode.
  - renderImage
```
public void renderImage(MarkupOutput out,
                        java.lang.String image)
```
    Renders an image in the transform.
    
    Overrides:
    
    renderImage in class AbstractAppTransform
    
    Parameters:
    
    out - The transform's output.
    
    image - The image name.
  - renderFormStart
```
public void renderFormStart(MarkupOutput out)
```
    Renders the FORM start tag.
    
    Parameters:
    
    out - The transform's output.
  - renderFormEnd
```
public void renderFormEnd(MarkupOutput out)
```
    Renders the FORM end tag.
    
    Parameters:
    
    out - The transform's output.
  - initializeImages
```
public void initializeImages()
```
    Initialize the images to be used by this transform.
    
    Overrides:
    
    initializeImages in class AbstractAppTransform
  - initializeCss
```
public void initializeCss()
```
    Initialize the css classes to be used by this transform.
    
    Overrides:
    
    initializeCss in class AbstractAppTransform
  - checkLevel
```
public boolean checkLevel(int column)
```
    Checks the level flag with the level of a column to decide if we want to render a particular column.
    
    Parameters:
    
    column - The ID of the column to use. The level is determined by the levelFlag FormalParameter Possible values are the LEVEL_ fieds, i.e: LEVEL_DISPLAY_NAME
    
    Returns:
    
    true If the given level is included in the levelFlag.
  - getEventCancel
```
public WebEvent getEventCancel()
```
    Returns the event to cancel editing or saving an address.
    
    Returns:
    
    The EnumServletEvents.WebEventCancel event.
  - getEventSetDefault
```
public WebEvent getEventSetDefault()
```
    Returns the event to change the current default address.
    
    Returns:
    
    The EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_CHANGE_DEFAULT event.
  - getEventEdit
```
public WebEvent getEventEdit(WebSubscriptionAddress address)
```
    Returns the event to edit an existing address.
    
    Parameters:
    
    address - The address to edit.
    
    Returns:
    
    The EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_INIT_ADDRESS event.
  - getEventAdd
```
public WebEvent getEventAdd()
```
    Returns the event to add a new address.
    
    Returns:
    
    The EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_CREATE_NEW_ADDRESS event.
  - getEventRemove
```
public WebEvent getEventRemove(WebSubscriptionAddress address)
```
    Returns the event to delete an existing address.
    
    Parameters:
    
    address - The address to remove.
    
    Returns:
    
    The EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_DELETE event.
  - getEventSave
```
public WebEvent getEventSave()
```
    Returns the event to save the address currently being editing
    
    Returns:
    
    The EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_SAVE event.
  - getSupportedBeanType
```
public java.lang.Class getSupportedBeanType()
```
    Returns the supported bean type for the transform.
    
    Specified by:
    
    getSupportedBeanType in interface Transform
    
    Overrides:
    
    getSupportedBeanType in class AbstractAppTransform
    
    Returns:
    
    The AddressListBean bean for this transform.
  - getAvailableDevices
```
protected SimpleList getAvailableDevices()
```
    Returns the list of supported devices for email addresses.
    
    Returns:
    
    The SimpleList supported devices for email addresses.
    
    Since:
    
    MicroStrategy Web 7.5.1
  - getAddressListBean
```
protected AddressListBean getAddressListBean()
```
    Returns the list of supported devices for email addresses.
    
    Returns:
    
    The SimpleList supported devices for email addresses.
    
    Since:
    
    MicroStrategy Web 7.5.1

Class AddressListTransform

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

Field Summary

Fields inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

Constructor Summary

Method Summary

Methods inherited from class com.microstrategy.web.app.transforms.AddressTransform

Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform

Methods inherited from class com.microstrategy.web.transform.AbstractTransform

Methods inherited from class java.lang.Object

Methods inherited from interface com.microstrategy.web.transform.Transform

Field Detail

cssHeader

cssContent

cssFooter

cssTableHeader

cssItem

cssSelectedItem

LEVEL_DISPLAY_NAME

LEVEL_PHYSICAL_ADDRESS

LEVEL_DEVICE_NAME

LEVEL_REMOVE

LEVEL_EDIT

LEVEL_ADD

LEVEL_SET_DEFAULT

LEVEL_COLUMN_HEADERS

LEVEL_OUTER_FRAME

LEVEL_ALL

FP_IMG_CHECK

FP_IMG_UPPER_LEFT

FP_IMG_UPPER_RIGHT

FP_LEVEL_FLAG

FP_MAX_ITEMS_COUNT

FP_CONFIRM_DELETE

checkImage

upperLeftCornerImage

upperRightCornerImage

levelFlag

_levelFlag

maxItemCount

_maxItemCount

confirmDelete

Constructor Detail

AddressListTransform

Method Detail

getDescription

initializeTransform

getAddresses

setAddresses

transformForRequestWaitingForUserInput

transformForRequestInError

transformForRequestNotInited

transformForRequestSuccessful

transformHeader

getTitle

transformFooter

renderSetDefaultButton

isNewAvailable

isEditMode

renderAddressesTable

canDisplayNewAddressLink

transformBody

renderNewLink

generateAnchor

isNewAddress

renderColgroups

renderHeaders

renderHeader

renderHeaderContent

renderEmtpyList

renderEmptyAddress

renderList

isAddressInEditMode

renderAddress

renderAddress

renderSetDefaultInfo

renderSetDefaultField

renderDisplayNameInfo