Class SortEditorTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.AbstractEditorTransform
-
- com.microstrategy.web.app.transforms.SortEditorTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
public class SortEditorTransform extends AbstractEditorTransform implements LayoutTransform
This transform renders the list of projects to show to the user for logging in.- Since:
- MicroStrategy Web 8.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.AbstractEditorTransform
_helpTopic, _helpType, applyJS, applyLabel, applyLabelID, canAutoSize, cancelJS, cancelLabel, cancelLabelID, closeEvent, closeImage, closeJS, closeLabel, closeLabelID, dhtmlClose, disableOKButton, editorContentsStyle, editorElements, editorLayoutFile, editorSubType, FP_APPLY_JS, FP_APPLY_LABEL, FP_APPLY_LABEL_ID, FP_CAN_AUTO_SIZE, FP_CANCEL_JS, FP_CANCEL_LABEL, FP_CANCEL_LABEL_ID, FP_CLOSE_EVENT, FP_CLOSE_IMAGE, FP_CLOSE_JS, FP_CLOSE_LABEL, FP_CLOSE_LABEL_ID, FP_DHTML_CLOSE, FP_DISABLE_OK_BUTTON, FP_EDITOR_CONTENTS_STYLE, FP_EDITOR_ELEMENTS, FP_EDITOR_LAYOUT_FILE, FP_EDITOR_SUBTYPE, FP_HELP_PAGE, FP_HELP_TOPIC, FP_HELP_TYPE, FP_INCLUDE_DYNAMIC_SCRIPT, FP_NAVIGATE_ON_SUBMIT, FP_OK_JS, FP_OK_LABEL, FP_OK_LABEL_ID, FP_RENDER_FORM, FP_TITLE_LABEL, FP_TITLE_LABEL_ID, FP_USE_JS_IN_BONE, helpPage, helpTopic, helpType, includeDynamicScript, navigateOnSubmit, okJS, okLabel, okLabelID, renderForm, titleLabel, titleLabelID
-
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 SortEditorTransform()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDescription()
Returns the textual description of the transformboolean
getHasGroupByUnits()
Indicates whether the document has group by attributes.boolean
getIsGridSelected()
Indicates whether the sort editor is being used to sort a selected gridprotected 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
renderAscendingRadioButton(MarkupOutput out)
Renders a radio button to select the ascending order for sorting by template units/document attributes.void
renderColTabLink(MarkupOutput out)
void
renderCurrentTabContent(MarkupOutput out)
void
renderDescendingRadioButton(MarkupOutput out)
Renders a radio button to select the descending order for sorting by template units/document attributes.void
renderEditorContents(MarkupOutput out)
Generates the graphical output for the Projects Beanvoid
renderGroupByAscendingRadioButton(MarkupOutput out, SortDefinition sortDef)
Renders a radio button to select the ascending order for sorting group by attributes.void
renderGroupByDescendingRadioButton(MarkupOutput out, SortDefinition sortDef)
Renders a radio button to select the descending order for sorting group by attributes.void
renderGroupByForms(MarkupOutput out, SortDefinition sortDef)
The method renders a select box containing all the available forms to sort by associated with the group by information included in the sortDef parameter.void
renderGroupByInfo(MarkupOutput out)
Renders the Sort Group By section for Documentsvoid
renderHiddenInputs(MarkupOutput out)
Renders the list of hidden inputs required by the editorvoid
renderRowTabLink(MarkupOutput out)
void
renderSortByInfo(MarkupOutput out)
Renders the sort options for the selected grid and for the document attributesvoid
renderSortNumber(MarkupOutput out, java.lang.Integer value)
void
renderTemplateUnits(MarkupOutput out)
The method renders a select box containing all the available template units and its forms in case a grid has been selected or the attributes of the default data set associated with a document.-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractEditorTransform
generateForm, getDivTagAroundContents, getEditorTitle, getOnSubmitJS, getWebBeanErrorInfo, initEditor, initHelp, renderEditor, renderEditorElement, renderJavascript, setFocusFieldId, transformForRequestInError, transformForRequestSuccessful
-
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, 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, 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
-
-
-
-
Method Detail
-
initializeTransform
public void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractEditorTransform
- Parameters:
data
- bean that will be transformed
-
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Returns the supported bean type. This transform supportsSortEditorBean
instances- Specified by:
getSupportedBeanType
in interfaceTransform
- Overrides:
getSupportedBeanType
in classAbstractAppTransform
- Returns:
SortEditorBean.class
-
getDescription
public java.lang.String getDescription()
Returns the textual description of the transform- Specified by:
getDescription
in interfaceTransform
- 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.
-
getHasGroupByUnits
public boolean getHasGroupByUnits()
Indicates whether the document has group by attributes.- Returns:
- true if the are group by attributes in the document
-
renderEditorContents
public void renderEditorContents(MarkupOutput out)
Generates the graphical output for the Projects Bean- Specified by:
renderEditorContents
in classAbstractEditorTransform
- Parameters:
out
-MarkupOutput
instance where to create the HTML output
-
renderSortByInfo
public void renderSortByInfo(MarkupOutput out)
Renders the sort options for the selected grid and for the document attributes- Parameters:
out
-MarkupOutput
instance where to create the HTML output
-
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 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
-
renderAscendingRadioButton
public void renderAscendingRadioButton(MarkupOutput out)
Renders a radio button to select the ascending order for sorting by template units/document attributes.- Parameters:
out
-MarkupOutput
instance where to create the HTML output
-
renderDescendingRadioButton
public void renderDescendingRadioButton(MarkupOutput out)
Renders a radio button to select the descending order for sorting by template units/document attributes.- Parameters:
out
-MarkupOutput
instance where to create the HTML output
-
renderGroupByInfo
public void renderGroupByInfo(MarkupOutput out)
Renders the Sort Group By section for Documents- Parameters:
out
-MarkupOutput
instance where to create the HTML output
-
renderGroupByAscendingRadioButton
public void renderGroupByAscendingRadioButton(MarkupOutput out, SortDefinition sortDef)
Renders a radio button to select the ascending order for sorting group by attributes.- Parameters:
out
-MarkupOutput
instance where to create the HTML outputsortDef
-SortDefinition
instance containing the sort information associated with a group by attribute
-
renderGroupByDescendingRadioButton
public void renderGroupByDescendingRadioButton(MarkupOutput out, SortDefinition sortDef)
Renders a radio button to select the descending order for sorting group by attributes.- Parameters:
out
-MarkupOutput
instance where to create the HTML outputsortDef
-SortDefinition
instance containing the sort information associated with a group by attribute
-
renderGroupByForms
public void renderGroupByForms(MarkupOutput out, SortDefinition sortDef)
The method renders a select box containing all the available forms to sort by associated with the group by information included in the sortDef parameter.- Parameters:
out
-MarkupOutput
instance where to create the HTML outputsortDef
-SortDefinition
instance containing the sort information associated with a group by attribute
-
renderRowTabLink
public void renderRowTabLink(MarkupOutput out)
- Since:
- MicroStrategy Web 9.0.0
-
renderColTabLink
public void renderColTabLink(MarkupOutput out)
- Since:
- MicroStrategy Web 9.0.0
-
renderCurrentTabContent
public void renderCurrentTabContent(MarkupOutput out)
- Since:
- MicroStrategy Web 9.0.0
-
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)
- Since:
- MicroStrategy Web 9.0.0
-
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
- Since:
- MicroStrategy Web 9.0.0
-
-