Package com.microstrategy.web.app.transforms

Class SortGeneralTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.app.transforms.SortGeneralTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class SortGeneralTransform
extends AbstractAppTransform
implements LayoutTransform

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

Modifier and Type	Field	Description
static java.lang.String	FP_RENDER_FORM
FormalParameter	renderForm	Indicates whether the editor will create its own form.

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()	Returns the textual description of the transform
boolean	getIsGridSelected()	Indicates whether the sort editor is being used to sort a selected grid
protected WebEvent	getSortProcessEvent()
java.lang.Class	getSupportedBeanType()	Returns the supported bean type.
void	initializeTransform(Transformable data)	This method initialize the private and protected fields of the transform.
java.util.ArrayList<java.lang.Integer>	numberOfSortKeys()	Returns a list of integers until the value of the set preference.
void	renderAscendingRadioButtonByAxis(MarkupOutput out, int axis)	Deprecated. use renderAscendingRadioButtonByAxis(MarkupOutput, int, String)
void	renderAscendingRadioButtonByAxis(MarkupOutput out, int axis, java.lang.String descriptorKey)
void	renderColSortingUnits(MarkupOutput out)
void	renderDescendingRadioButtonByAxis(MarkupOutput out, int axis)	Deprecated. use renderDescendingRadioButtonByAxis(MarkupOutput, int, String)
void	renderDescendingRadioButtonByAxis(MarkupOutput out, int axis, java.lang.String descriptorKey)
void	renderHiddenInputs(MarkupOutput out)	Renders the list of hidden inputs required by the editor
void	renderRespectParent(MarkupOutput out, int axis, java.lang.String descriptorKey)
void	renderSortNumber(MarkupOutput out, java.lang.Integer value)
void	renderTemplateUnits(MarkupOutput out)	The method renders a select box containing all the available template units for row sorting and its forms in case a grid has been selected or the attributes of the default data set associated with a document.
void	transformForRequestSuccessful(MarkupOutput out)	Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestSuccessful.

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

addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchor, 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, initializeCss, initializeImages, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderImage, 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, transformForRequestInError, transformForRequestNotInited, transformForRequestProcessing, transformForRequestWaitingForUserInput

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

getLayoutDefinition, setLayoutDefinition

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

canTransform, getFormalParams, getID, getPreview, isPreviewAvailable, isResolved, supports, supports, transform

Field Detail

FP_RENDER_FORM

public static final java.lang.String FP_RENDER_FORM

See Also:

Constant Field Values

renderForm

public FormalParameter renderForm

Indicates whether the editor will create its own form.

Constructor Detail

SortGeneralTransform

public SortGeneralTransform()

Method Detail

initializeTransform

public void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform.

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class AbstractAppTransform

Parameters:

data - bean that will be transformed

getSupportedBeanType

public java.lang.Class getSupportedBeanType()

Returns the supported bean type. This transform supports SortEditorBean instances

Specified by:

getSupportedBeanType in interface Transform

Overrides:

getSupportedBeanType in class AbstractAppTransform

Returns:

SortEditorBean.class

getDescription

public java.lang.String getDescription()

Returns the textual description of the transform

Specified by:

getDescription in interface Transform

Returns:

the description of the transform

getIsGridSelected

public boolean getIsGridSelected()

Indicates whether the sort editor is being used to sort a selected grid

Returns:

true if a grid has been selected by the user.

renderHiddenInputs

public void renderHiddenInputs(MarkupOutput out)

Renders the list of hidden inputs required by the editor

Parameters:

out - MarkupOutput instance where to create the HTML output

renderTemplateUnits

public void renderTemplateUnits(MarkupOutput out)

The method renders a select box containing all the available template units for row sorting and its forms in case a grid has been selected or the attributes of the default data set associated with a document.

Parameters:

out - MarkupOutput instance where to create the HTML output

renderAscendingRadioButtonByAxis

public void renderAscendingRadioButtonByAxis(MarkupOutput out,
                                             int axis)

Deprecated.

use renderAscendingRadioButtonByAxis(MarkupOutput, int, String)

Parameters:

out -

axis -

renderAscendingRadioButtonByAxis

public void renderAscendingRadioButtonByAxis(MarkupOutput out,
                                             int axis,
                                             java.lang.String descriptorKey)

renderDescendingRadioButtonByAxis

public void renderDescendingRadioButtonByAxis(MarkupOutput out,
                                              int axis)

Deprecated.

use renderDescendingRadioButtonByAxis(MarkupOutput, int, String)

Parameters:

out -

axis -

renderDescendingRadioButtonByAxis

public void renderDescendingRadioButtonByAxis(MarkupOutput out,
                                              int axis,
                                              java.lang.String descriptorKey)

renderRespectParent

public void renderRespectParent(MarkupOutput out,
                                int axis,
                                java.lang.String descriptorKey)

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput out)

Description copied from class: AbstractAppTransform

Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestSuccessful. This is the main entry point to generate the output for those Transforms that just want to render the "regular" bean case.
This is an abstract method. All classes need to implement it.

Specified by:

transformForRequestSuccessful in class AbstractAppTransform

Parameters:

out - output by this transform

See Also:

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

renderColSortingUnits

public void renderColSortingUnits(MarkupOutput out)

getSortProcessEvent

protected WebEvent getSortProcessEvent()

Returns:

an intance of the Sort Editor Process event the editor uses

renderSortNumber

public void renderSortNumber(MarkupOutput out,
                             java.lang.Integer value)

numberOfSortKeys

public java.util.ArrayList<java.lang.Integer> numberOfSortKeys()

Returns a list of integers until the value of the set preference.

Returns:

list of integers