public class

AddressListTransform

extends AddressTransform
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
Known Direct Subclasses

Class Overview

This transform is used to list and edit Narrowcast Addresses. It also allows to add new addresses and set default addresses.

Summary

Constants
String FP_CONFIRM_DELETE Constant for the name of the confirmDelete Formal Parameter.
String FP_IMG_CHECK Constant for the name of the checkImage Formal Parameter.
String FP_IMG_UPPER_LEFT This constant is deprecated. This image is no longer required, the header of the preferences page is defined with css styles
String FP_IMG_UPPER_RIGHT This constant is deprecated. This image is no longer required, the header of the preferences page is defined with css styles
String FP_LEVEL_FLAG Constant for the name of the levelFlag Formal Parameter.
String FP_MAX_ITEMS_COUNT Constant for the name of the maxItemCount Formal Parameter.
int LEVEL_ADD LEVEL parameter that specifies to include a link to add new addresses
int LEVEL_ALL LEVEL parameter that includes all LEVEL parameters.
int LEVEL_COLUMN_HEADERS LEVEL parameter that specifies to include the column headers
int LEVEL_DEVICE_NAME LEVEL parameter that specifies to include the address device name
int LEVEL_DISPLAY_NAME LEVEL parameter that specifies to include the address display name
int LEVEL_EDIT LEVEL parameter that specifies to include a link to edit the address.
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.
int LEVEL_PHYSICAL_ADDRESS LEVEL parameter that specifies to include the address physical address
int LEVEL_REMOVE LEVEL parameter that specifies to include a link to remove the address
int LEVEL_SET_DEFAULT LEVEL parameter that specifies to include a link to set any of the addresses as default
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
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
public FormalParameter checkImage The name of the image used to indicate the default address.
public FormalParameter confirmDelete Indicates whether to confirm or not before deleting an address.
protected String cssContent This field is deprecated. This CSS is no longer required as we use new styles for this purpose rather than nested tables.
protected String cssFooter This field is deprecated. This CSS is no longer required as we use new styles for this purpose rather than nested tables.
protected String cssHeader This field is deprecated. This CSS is no longer required as we use new styles for this purpose rather than nested tables.
protected String cssItem Variable to hold the CSS class for the each of the individual address items
protected String cssSelectedItem Variable to hold the CSS class for the individual items of a selected address or for editing or a new address
protected String cssTableHeader Variable to hold the CSS class for the headers of the listed addresses
public FormalParameter levelFlag Specifies what information is displayed for each address.
public FormalParameter maxItemCount Indicates how many addresses will be displayed in the address list.
public FormalParameter upperLeftCornerImage This field is deprecated. This image is no longer required, the header of the preferences page is defined with css styles
public FormalParameter upperRightCornerImage This field is deprecated. This image is no longer required, the header of the preferences page is defined with css styles
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AddressListTransform()
Default no argument constructor.
Public Methods
boolean checkLevel(int column)
Checks the level flag with the level of a column to decide if we want to render a particular column.
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.
Class getSupportedBeanType()
Returns the supported bean type for the transform.
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.
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.
void renderColgroups(MarkupOutput out)
Renders all column headers for the address list.
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.
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.
void renderHeaders(MarkupOutput out)
Renders all column headers for the address list.
void renderImage(MarkupOutput out, String image)
Renders an image in the transform.
void renderList(MarkupOutput out, SimpleList list)
Renders a non-empty list of addresses.
void renderPhysicalAddressField(MarkupOutput out, WebSubscriptionAddress address, boolean edit)
void renderPhysicalAddressInfo(MarkupOutput out, WebSubscriptionAddress address, boolean edit)
Renders the physical address column of an address.
void renderSetDefaultField(MarkupOutput out, WebSubscriptionAddress address, boolean edit)
void renderSetDefaultInfo(MarkupOutput out, WebSubscriptionAddress address, boolean edit)
Renders the default column of an address.
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 Methods
void addAttributesToLinkAnchor(Tag anchor)
boolean canDisplayNewAddressLink()
AnchorTag generateAnchor(WebEvent event)
Overwrites parent method by testing if anchor should be enabled for iframe environment
AddressListBean getAddressListBean()
Returns the list of supported devices for email addresses.
SimpleList getAddresses()
SimpleList getAvailableDevices()
Returns the list of supported devices for email addresses.
String getSelectedDeviceId(WebSubscriptionAddress address)
boolean isAddressInEditMode(WebSubscriptionAddress address)
boolean isEditMode()
boolean isNewAddress(WebSubscriptionAddress address, SimpleList addresses)
boolean isNewAvailable()
void renderAddressesTable(MarkupOutput out)
boolean renderCancelInputButton(MarkupOutput out)
boolean renderDeleteLink(MarkupOutput out, WebSubscriptionAddress address)
boolean renderEditLink(MarkupOutput out, WebSubscriptionAddress address)
void renderHeaderContent(MarkupOutput out, int column)
void renderNewLink(MarkupOutput out)
boolean renderSaveButton(MarkupOutput out)
void renderSetDefaultButton(MarkupOutput out)
void setAddresses(SimpleList addresses)
void transformBody(MarkupOutput out)
This is called to generate the main body of the Address List dialog.
void transformFooter(MarkupOutput out)
Generates the Footer of the Address List dialog.
void transformHeader(MarkupOutput out)
Generates the Header of the Address List dialog.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AddressTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final String FP_CONFIRM_DELETE

Constant for the name of the confirmDelete Formal Parameter.

See Also
Constant Value: "confirmDelete"

public static final String FP_IMG_CHECK

Constant for the name of the checkImage Formal Parameter.

See Also
Constant Value: "checkImage"

public static final String FP_IMG_UPPER_LEFT

This constant is 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.

Constant Value: "upperLeftCornerImage"

public static final String FP_IMG_UPPER_RIGHT

This constant is 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.

Constant Value: "upperRightCornerImage"

public static final String FP_LEVEL_FLAG

Constant for the name of the levelFlag Formal Parameter.

See Also
Constant Value: "levelFlag"

public static final String FP_MAX_ITEMS_COUNT

Constant for the name of the maxItemCount Formal Parameter.

See Also
Constant Value: "maxItemCount"

public static final int LEVEL_ADD

LEVEL parameter that specifies to include a link to add new addresses

Constant Value: 64 (0x00000040)

public static final int LEVEL_ALL

LEVEL parameter that includes all LEVEL parameters.

Constant Value: 65535 (0x0000ffff)

public static final int LEVEL_COLUMN_HEADERS

LEVEL parameter that specifies to include the column headers

Constant Value: 256 (0x00000100)

public static final int LEVEL_DEVICE_NAME

LEVEL parameter that specifies to include the address device name

Constant Value: 4 (0x00000004)

public static final int LEVEL_DISPLAY_NAME

LEVEL parameter that specifies to include the address display name

Constant Value: 1 (0x00000001)

public static final int LEVEL_EDIT

LEVEL parameter that specifies to include a link to edit the address.

Constant Value: 32 (0x00000020)

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.

Constant Value: 512 (0x00000200)

public static final int LEVEL_PHYSICAL_ADDRESS

LEVEL parameter that specifies to include the address physical address

Constant Value: 2 (0x00000002)

public static final int LEVEL_REMOVE

LEVEL parameter that specifies to include a link to remove the address

Constant Value: 16 (0x00000010)

public static final int LEVEL_SET_DEFAULT

LEVEL parameter that specifies to include a link to set any of the addresses as default

Constant Value: 128 (0x00000080)

Fields

protected int _levelFlag

Variable to hold the value of the levelFlag Formal Parameter

See Also

protected int _maxItemCount

Variable to hold the value of the maxItemCount Formal Parameter

See Also

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"

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.

protected String cssContent

This field is 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

protected String cssFooter

This field is 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

protected String cssHeader

This field is 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

protected String cssItem

Variable to hold the CSS class for the each of the individual address items

protected String cssSelectedItem

Variable to hold the CSS class for the individual items of a selected address or for editing or a new address

protected String cssTableHeader

Variable to hold the CSS class for the headers of the listed addresses

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).

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.

public FormalParameter upperLeftCornerImage

This field is 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.

public FormalParameter upperRightCornerImage

This field is 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.

Public Constructors

public AddressListTransform ()

Default no argument constructor. Initialize formal parameters.

Public Methods

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.

public String getDescription ()

Returns the description of this transform.
This is used in the style catalog editor.

Returns
  • The description of this transform.

public InputTag getEditDisplayNameField (WebSubscriptionAddress address)

public InputTag getEditPhysicalAddressInput (WebSubscriptionAddress address)

public WebEvent getEventAdd ()

Returns the event to add a new address.

Returns
  • The EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_CREATE_NEW_ADDRESS event.

public WebEvent getEventCancel ()

Returns the event to cancel editing or saving an address.

Returns
  • The EnumServletEvents.WebEventCancel event.

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.

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.

public WebEvent getEventSave ()

Returns the event to save the address currently being editing

Returns
  • The EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_SAVE event.

public WebEvent getEventSetDefault ()

Returns the event to change the current default address.

Returns
  • The EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_CHANGE_DEFAULT event.

public Class getSupportedBeanType ()

Returns the supported bean type for the transform.

Returns

public 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.

public void initializeCss ()

Initialize the css classes to be used by this transform.

public void initializeImages ()

Initialize the images to be used by this transform.

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.

Parameters
data The bean to transform

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.

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

public void renderColgroups (MarkupOutput out)

Renders all column headers for the address list.

Parameters
out The transform's output.

public void renderDeviceField (MarkupOutput out, WebSubscriptionAddress address, boolean edit)

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.

public void renderDisplayNameField (MarkupOutput out, WebSubscriptionAddress address, boolean edit)

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.

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.

public void renderEmptyAddress (MarkupOutput out)

Renders an empty address when there is addresses available for that delivery mode

Throws
WebBeanException

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.

public void renderFormEnd (MarkupOutput out)

Renders the FORM end tag.

Parameters
out The transform's output.

public void renderFormStart (MarkupOutput out)

Renders the FORM start tag.

Parameters
out The transform's output.

public void renderHeader (MarkupOutput out, int column)

Renders a single column header for the Address List. Calls renderHeaderContent(MarkupOutput, int) for displaying the text and other content related with the header.

Parameters
out The transform's output.
column The column to render

public void renderHeaders (MarkupOutput out)

Renders all column headers for the address list.

Parameters
out The transform's output.

public void renderImage (MarkupOutput out, String image)

Renders an image in the transform.

Parameters
out The transform's output.
image The image name.

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

public void renderPhysicalAddressField (MarkupOutput out, WebSubscriptionAddress address, boolean edit)

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.

public void renderSetDefaultField (MarkupOutput out, WebSubscriptionAddress address, boolean edit)

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.

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.

Parameters
out the transform's output

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.

Parameters
out Output by this transform

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.

Parameters
out The transform's output.

public void transformForRequestWaitingForUserInput (MarkupOutput out)

Transform when the status is WaitingForUserInputessful.
Overwrites by showing the Preferences form. It paints the address list form.

Parameters
out the transform's output

Protected Methods

protected void addAttributesToLinkAnchor (Tag anchor)

protected boolean canDisplayNewAddressLink ()

protected AnchorTag generateAnchor (WebEvent event)

Overwrites parent method by testing if anchor should be enabled for iframe environment

Parameters
event WebEvent
Returns
  • AnchorTag

protected AddressListBean getAddressListBean ()

Returns the list of supported devices for email addresses.

Returns
  • The SimpleList supported devices for email addresses.

protected SimpleList getAddresses ()

protected SimpleList getAvailableDevices ()

Returns the list of supported devices for email addresses.

Returns
  • The SimpleList supported devices for email addresses.

protected String getSelectedDeviceId (WebSubscriptionAddress address)

protected boolean isAddressInEditMode (WebSubscriptionAddress address)

protected boolean isEditMode ()

protected boolean isNewAddress (WebSubscriptionAddress address, SimpleList addresses)

protected boolean isNewAvailable ()

protected void renderAddressesTable (MarkupOutput out)

protected boolean renderCancelInputButton (MarkupOutput out)

protected boolean renderDeleteLink (MarkupOutput out, WebSubscriptionAddress address)

protected boolean renderEditLink (MarkupOutput out, WebSubscriptionAddress address)

protected void renderHeaderContent (MarkupOutput out, int column)

protected void renderNewLink (MarkupOutput out)

protected boolean renderSaveButton (MarkupOutput out)

protected void renderSetDefaultButton (MarkupOutput out)

protected void setAddresses (SimpleList addresses)

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.

protected void transformFooter (MarkupOutput out)

Generates the Footer of the Address List dialog.

Parameters
out The transform's output.

protected void transformHeader (MarkupOutput out)

Generates the Header of the Address List dialog.

Parameters
out The transform's output.