public class

UserAddressListTransform

extends AddressListTransform
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
             ↳ com.microstrategy.web.app.transforms.UserAddressListTransform

Class Overview

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

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AddressListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AddressListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
UserAddressListTransform()
Default no argument constructor.
Public Methods
String getDescription()
Returns the description of this transform.
InputTag getEditDisplayNameField(WebSubscriptionAddress address)
InputTag getEditPhysicalAddressInput(WebSubscriptionAddress address)
WebEvent getEventCancel()
Returns the event to cancel editing or saving an address.
WebEvent getEventSave()
Returns the event to save the address currently being editing
Class getSupportedBeanType()
Returns the supported bean type for the transform.
String getTitle()
Retrieves the Title for the dialog.
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
void renderEditInfo(MarkupOutput out, WebSubscriptionAddress address, boolean edit)
Renders the edit/remove column of an address.
void renderEmtpyList(MarkupOutput out)
Renders an empty list of addresses.
void renderFormStart(MarkupOutput out)
Renders the FORM start tag.
void transformForRequestWaitingForUserInput(MarkupOutput out)
Transform when the status is WaitingForUserInputessful.
Protected Methods
void addAttributesToLinkAnchor(Tag anchor)
int getCurrentAddressType()
AddressListBean getUserAddressListBean()
boolean isAddressInEditMode(WebSubscriptionAddress address)
boolean isEditMode()
void renderAddressListInformation(MarkupOutput out, int delMode)
void renderAddressesTable(MarkupOutput out)
boolean renderDeleteLink(MarkupOutput out, WebSubscriptionAddress address)
void renderHeaderContent(MarkupOutput out, int column)
void renderNewLink(MarkupOutput out)
Overwrites parent method by generating a button instead
void renderRegisterBone(MarkupOutput out)
If a scriptClass is specified, this method registers the corresponding javascript bone for this component.
boolean renderSaveButton(MarkupOutput out)
void renderSetDefaultButton(MarkupOutput out)
void setBoneProperties(JsonGenerator boneProps)
Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.
void setCurrentAddressType(int type)
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AddressListTransform
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

Public Constructors

public UserAddressListTransform ()

Default no argument constructor. Initialize formal parameters.

Public Methods

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 getEventCancel ()

Returns the event to cancel editing or saving an address.

Returns
  • The EnumServletEvents.WebEventCancel event.

public WebEvent getEventSave ()

Returns the event to save the address currently being editing

Returns
  • The EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_SAVE 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 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 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 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 renderFormStart (MarkupOutput out)

Renders the FORM start tag.

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 int getCurrentAddressType ()

protected AddressListBean getUserAddressListBean ()

protected boolean isAddressInEditMode (WebSubscriptionAddress address)

protected boolean isEditMode ()

protected void renderAddressListInformation (MarkupOutput out, int delMode)

protected void renderAddressesTable (MarkupOutput out)

protected boolean renderDeleteLink (MarkupOutput out, WebSubscriptionAddress address)

protected void renderHeaderContent (MarkupOutput out, int column)

protected void renderNewLink (MarkupOutput out)

Overwrites parent method by generating a button instead

protected void renderRegisterBone (MarkupOutput out)

If a scriptClass is specified, this method registers the corresponding javascript bone for this component.

Parameters
out MarkupOutput whether the output should be rendered.

protected boolean renderSaveButton (MarkupOutput out)

protected void renderSetDefaultButton (MarkupOutput out)

protected void setBoneProperties (JsonGenerator boneProps)

Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.

Parameters
boneProps the JsonGenerator object that contains the collection of bone properties.

protected void setCurrentAddressType (int type)