Class WebHyperLinkEditorTransform
- 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.WebHyperLinkEditorTransform
 
 
 
 
 
 
- 
- All Implemented Interfaces:
 AppTransform,LayoutTransform,Transform
public class WebHyperLinkEditorTransform extends AbstractEditorTransform 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 intSTATE_CHANGEDstatic intSTATE_NEWstatic intSTATE_UNCHANGED- 
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 WebHyperLinkEditorTransform() 
- 
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringgetDescription()Returns a textual description of the transform.java.lang.StringgetID()Returns the unique name of the component to be used as the ID for its shell.protected java.lang.StringgetScriptClass()Returns the name of the javaScript class (if any) to be associated with the component.java.lang.ClassgetSupportedBeanType()Returns the supported bean type.voidinitializeTransform(Transformable data)This method initializes the private and protected fields of the transform.voidrenderButtonList(MarkupOutput out)voidrenderEditorContents(MarkupOutput out)Generates the graphical output for the EditorvoidrenderElementSelector(MarkupOutput out)voidrenderFormSelector(MarkupOutput out)protected voidrenderJavascript(MarkupOutput out)This method should be used by the Editor transforms to generate any javascript necessary.voidrenderLinkInfoBegin(MarkupOutput out)voidrenderLinkInfoEnd(MarkupOutput out)voidrenderLinkList(MarkupOutput out)voidrenderLinkName(MarkupOutput out)voidrenderMobileURLSelector(MarkupOutput out)voidrenderObjectSelector(MarkupOutput out)voidrenderOpenInNewWindow(MarkupOutput out)voidrenderPromptList(MarkupOutput output)voidrenderPromptTypeSelector(MarkupOutput out)voidrenderSelectorOptions(MarkupOutput out)voidrenderTypeInputForMobileURL(MarkupOutput out)voidrenderTypeInputForObject(MarkupOutput out)voidrenderTypeInputForURL(MarkupOutput out)voidrenderURLInput(MarkupOutput out)- 
Methods inherited from class com.microstrategy.web.app.transforms.AbstractEditorTransform
generateForm, getDivTagAroundContents, getEditorTitle, getOnSubmitJS, getWebBeanErrorInfo, initEditor, initHelp, renderEditor, renderEditorElement, 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, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, 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, getPreview, isPreviewAvailable, isResolved, supports, supports, transform 
 - 
 
 - 
 
- 
- 
Field Detail
- 
STATE_UNCHANGED
public static final int STATE_UNCHANGED
- See Also:
 - Constant Field Values
 
 
- 
STATE_CHANGED
public static final int STATE_CHANGED
- See Also:
 - Constant Field Values
 
 
- 
STATE_NEW
public static final int STATE_NEW
- See Also:
 - Constant Field Values
 
 
 - 
 
- 
Method Detail
- 
getScriptClass
protected java.lang.String getScriptClass()
Description copied from class:AbstractAppTransformReturns the name of the javaScript class (if any) to be associated with the component. When the scriptClass is specified, a bone is registered on the page for this component.
A bone is the corresponding concept of a bean in Microstrategy's javascript environment.
By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method.- Overrides:
 getScriptClassin classAbstractAppTransform- Returns:
 Stringrepresenting the name of a javaScript class
 
- 
initializeTransform
public void initializeTransform(Transformable data)
Description copied from class:AbstractEditorTransformThis method initializes the private and protected fields of the transform.- Specified by:
 initializeTransformin interfaceAppTransform- Overrides:
 initializeTransformin classAbstractEditorTransform- Parameters:
 data- bean that will be transformed- See Also:
 AbstractAppTransform.initializeTransform(com.microstrategy.web.beans.Transformable)
 
- 
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Description copied from class:AbstractAppTransformReturns the supported bean type. This abstract Transform supports allWebComponentsso every sub-class should override this method to return the class of theBeanthe Transform is expecting, for example:public class CustomReportClass extends AbstractAppTransform { public Class getSupportedBeanType() { //This Transform is expected to work only with a ReportBean, //therefore this method needs to return this class: return ReportBean.class; } }- Specified by:
 getSupportedBeanTypein interfaceTransform- Overrides:
 getSupportedBeanTypein classAbstractAppTransform- Returns:
 - a root class/interface supported by this transform.
 
 
- 
renderEditorContents
public void renderEditorContents(MarkupOutput out)
Description copied from class:AbstractEditorTransformGenerates the graphical output for the Editor- Specified by:
 renderEditorContentsin classAbstractEditorTransform- Parameters:
 out-MarkupOutputinstance where to create the HTML output
 
- 
renderLinkList
public void renderLinkList(MarkupOutput out)
 
- 
getID
public java.lang.String getID()
Description copied from class:AbstractAppTransformReturns the unique name of the component to be used as the ID for its shell. This id is used for updating the page using the iFrame technology, and as the id for the corresponding bone (if any).- Specified by:
 getIDin interfaceTransform- Overrides:
 getIDin classAbstractAppTransform- Returns:
 - the component's unique id
 
 
- 
renderButtonList
public void renderButtonList(MarkupOutput out)
 
- 
renderOpenInNewWindow
public void renderOpenInNewWindow(MarkupOutput out)
 
- 
renderLinkInfoBegin
public void renderLinkInfoBegin(MarkupOutput out)
 
- 
renderLinkInfoEnd
public void renderLinkInfoEnd(MarkupOutput out)
 
- 
renderLinkName
public void renderLinkName(MarkupOutput out)
 
- 
renderTypeInputForURL
public void renderTypeInputForURL(MarkupOutput out)
 
- 
renderURLInput
public void renderURLInput(MarkupOutput out)
 
- 
renderTypeInputForObject
public void renderTypeInputForObject(MarkupOutput out)
 
- 
renderObjectSelector
public void renderObjectSelector(MarkupOutput out)
 
- 
renderPromptList
public void renderPromptList(MarkupOutput output)
 
- 
renderTypeInputForMobileURL
public void renderTypeInputForMobileURL(MarkupOutput out)
 
- 
renderMobileURLSelector
public void renderMobileURLSelector(MarkupOutput out)
 
- 
renderPromptTypeSelector
public void renderPromptTypeSelector(MarkupOutput out)
 
- 
renderFormSelector
public void renderFormSelector(MarkupOutput out)
 
- 
renderSelectorOptions
public void renderSelectorOptions(MarkupOutput out)
 
- 
renderElementSelector
public void renderElementSelector(MarkupOutput out)
 
- 
renderJavascript
protected void renderJavascript(MarkupOutput out)
Description copied from class:AbstractEditorTransformThis method should be used by the Editor transforms to generate any javascript necessary.
The default implementation includes a call to theClientSideHelperto render the dynamic scrips and the registerBone call.- Overrides:
 renderJavascriptin classAbstractEditorTransform- Parameters:
 out-MarkupOutputwhere the output should be rendered.
 
- 
getDescription
public java.lang.String getDescription()
Description copied from interface:TransformReturns a textual description of the transform.- Specified by:
 getDescriptionin interfaceTransform- Returns:
 - The textual description of the transform.
 
 
 - 
 
 -