Package com.microstrategy.web.app.transforms

Class UserAddressListTransform

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

All Implemented Interfaces:

AppTransform, Transform

public class UserAddressListTransform
extends AddressListTransform

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

Since:

MicroStrategy Web 9.0.0

Nested Class Summary

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

AbstractAppTransform.Context

Field Summary

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

_levelFlag, _maxItemCount, checkImage, confirmDelete, cssContent, cssFooter, cssHeader, cssItem, cssSelectedItem, cssTableHeader, FP_CONFIRM_DELETE, FP_IMG_CHECK, FP_IMG_UPPER_LEFT, FP_IMG_UPPER_RIGHT, FP_LEVEL_FLAG, FP_MAX_ITEMS_COUNT, LEVEL_ADD, LEVEL_ALL, LEVEL_COLUMN_HEADERS, LEVEL_DEVICE_NAME, LEVEL_DISPLAY_NAME, LEVEL_EDIT, LEVEL_OUTER_FRAME, LEVEL_PHYSICAL_ADDRESS, LEVEL_REMOVE, LEVEL_SET_DEFAULT, levelFlag, maxItemCount, upperLeftCornerImage, upperRightCornerImage

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
UserAddressListTransform()	Default no argument constructor.

Method Summary

Modifier and Type	Method	Description
protected void	addAttributesToLinkAnchor(Tag anchor)
protected int	getCurrentAddressType()
java.lang.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
java.lang.Class	getSupportedBeanType()	Returns the supported bean type for the transform.
java.lang.String	getTitle()	Retrieves the Title for the dialog.
protected AddressListBean	getUserAddressListBean()
void	initializeTransform(Transformable data)	This method initialize the private and protected fields of the transform.
protected boolean	isAddressInEditMode(WebSubscriptionAddress address)
protected boolean	isEditMode()
protected void	renderAddressesTable(MarkupOutput out)
protected void	renderAddressListInformation(MarkupOutput out, int delMode)
protected boolean	renderDeleteLink(MarkupOutput out, WebSubscriptionAddress address)
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.
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.
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 AbstractAppTransform.scriptClass formal parameter) Usually called by AbstractAppTransform.renderRegisterBone(MarkupOutput) Can be overwritten to add or modify bone properties.
protected void	setCurrentAddressType(int type)
void	transformForRequestWaitingForUserInput(MarkupOutput out)	Transform when the status is WaitingForUserInputessful.

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

canDisplayNewAddressLink, checkLevel, generateAnchor, getAddresses, getAddressListBean, getAvailableDevices, getEventAdd, getEventEdit, getEventRemove, getEventSetDefault, getSelectedDeviceId, initializeCss, initializeImages, isNewAddress, isNewAvailable, renderAddress, renderAddress, renderCancelInputButton, renderColgroups, renderDeviceField, renderDeviceInfo, renderDisplayNameField, renderDisplayNameInfo, renderEditLink, renderEmptyAddress, renderFormEnd, renderHeader, renderHeaders, renderImage, renderList, renderPhysicalAddressField, renderPhysicalAddressInfo, renderSetDefaultField, renderSetDefaultInfo, setAddresses, transformBody, transformFooter, transformForRequestInError, transformForRequestNotInited, transformForRequestSuccessful, transformHeader

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, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, 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

Constructor Detail

UserAddressListTransform

public UserAddressListTransform()

Default no argument constructor. Initialize formal parameters.

Method Detail

setCurrentAddressType

protected void setCurrentAddressType(int type)

getCurrentAddressType

protected int getCurrentAddressType()

isEditMode

protected boolean isEditMode()

Overrides:

isEditMode in class AddressListTransform

getUserAddressListBean

protected AddressListBean getUserAddressListBean()

initializeTransform

public void initializeTransform(Transformable data)

Description copied from class: AddressListTransform

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 AddressListTransform

Parameters:

data - The bean to transform

isAddressInEditMode

protected boolean isAddressInEditMode(WebSubscriptionAddress address)

Overrides:

isAddressInEditMode in class AddressListTransform

renderFormStart

public void renderFormStart(MarkupOutput out)

Description copied from class: AddressListTransform

Renders the FORM start tag.

Overrides:

renderFormStart in class AddressListTransform

Parameters:

out - The transform's output.

renderAddressesTable

protected void renderAddressesTable(MarkupOutput out)

Overrides:

renderAddressesTable in class AddressListTransform

renderAddressListInformation

protected void renderAddressListInformation(MarkupOutput out,
                                            int delMode)

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 AddressListTransform

Parameters:

out - the transform's output

See Also:

AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)

getTitle

public java.lang.String getTitle()

Retrieves the Title for the dialog.

Overrides:

getTitle in class AddressListTransform

Returns:

The Title for the dialog. By default it is the current group, "Email Addresses" in this case.

setBoneProperties

protected void setBoneProperties(JsonGenerator boneProps)

Description copied from class: AbstractAppTransform

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

Overrides:

setBoneProperties in class AbstractAppTransform

Parameters:

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

renderNewLink

protected void renderNewLink(MarkupOutput out)

Overwrites parent method by generating a button instead

Overrides:

renderNewLink in class AddressListTransform

addAttributesToLinkAnchor

protected void addAttributesToLinkAnchor(Tag anchor)

Overrides:

addAttributesToLinkAnchor in class AddressListTransform

renderDeleteLink

protected boolean renderDeleteLink(MarkupOutput out,
                                   WebSubscriptionAddress address)

Overrides:

renderDeleteLink in class AddressListTransform

getEventCancel

public WebEvent getEventCancel()

Description copied from class: AddressListTransform

Returns the event to cancel editing or saving an address.

Overrides:

getEventCancel in class AddressListTransform

Returns:

The EnumServletEvents.WebEventCancel event.

renderHeaderContent

protected void renderHeaderContent(MarkupOutput out,
                                   int column)

Overrides:

renderHeaderContent in class AddressListTransform

getSupportedBeanType

public java.lang.Class getSupportedBeanType()

Returns the supported bean type for the transform.

Specified by:

getSupportedBeanType in interface Transform

Overrides:

getSupportedBeanType in class AddressListTransform

Returns:

The AddressListBean bean for this transform.

getDescription

public java.lang.String getDescription()

Description copied from class: AddressListTransform

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

Specified by:

getDescription in interface Transform

Overrides:

getDescription in class AddressListTransform

Returns:

The description of this transform.

getEventSave

public WebEvent getEventSave()

Description copied from class: AddressListTransform

Returns the event to save the address currently being editing

Overrides:

getEventSave in class AddressListTransform

Returns:

The EnumAddressListBeanEvents.ADDRESS_LIST_EVENT_SAVE event.

renderEditInfo

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

Description copied from class: AddressListTransform

Renders the edit/remove column of an address.
It also renders the save/cancel buttons if editing an address.

Overrides:

renderEditInfo in class AddressListTransform

Parameters:

out - The transform's output.

address - the address to render.

edit - Indicates whether to show the address in edit mode.

renderEmtpyList

public void renderEmtpyList(MarkupOutput out)

Description copied from class: AddressListTransform

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.

Overrides:

renderEmtpyList in class AddressListTransform

Parameters:

out - The transform's output.

renderSetDefaultButton

protected void renderSetDefaultButton(MarkupOutput out)

Overrides:

renderSetDefaultButton in class AddressListTransform

getEditPhysicalAddressInput

public InputTag getEditPhysicalAddressInput(WebSubscriptionAddress address)

Overrides:

getEditPhysicalAddressInput in class AddressListTransform

getEditDisplayNameField

public InputTag getEditDisplayNameField(WebSubscriptionAddress address)

Overrides:

getEditDisplayNameField in class AddressListTransform

renderSaveButton

protected boolean renderSaveButton(MarkupOutput out)

Overrides:

renderSaveButton in class AddressListTransform

renderRegisterBone

protected void renderRegisterBone(MarkupOutput out)

Description copied from class: AbstractAppTransform

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

Overrides:

renderRegisterBone in class AbstractAppTransform

Parameters:

out - MarkupOutput whether the output should be rendered.

See Also:

AbstractAppTransform.getScriptClass()