public class

WebHyperLinkEditorTransform

extends AbstractEditorTransform
implements LayoutTransform
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

Summary

Constants
int STATE_CHANGED
int STATE_NEW
int STATE_UNCHANGED
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
WebHyperLinkEditorTransform()
Public Methods
String getDescription()
Returns a textual description of the transform.
String getID()
Returns the unique name of the component to be used as the ID for its shell.
Class getSupportedBeanType()
Returns the supported bean type.
void initializeTransform(Transformable data)
This method initializes the private and protected fields of the transform.
void renderButtonList(MarkupOutput out)
void renderEditorContents(MarkupOutput out)
Generates the graphical output for the Editor
void renderElementSelector(MarkupOutput out)
void renderFormSelector(MarkupOutput out)
void renderLinkInfoBegin(MarkupOutput out)
void renderLinkInfoEnd(MarkupOutput out)
void renderLinkList(MarkupOutput out)
void renderLinkName(MarkupOutput out)
void renderMobileURLSelector(MarkupOutput out)
void renderObjectSelector(MarkupOutput out)
void renderOpenInNewWindow(MarkupOutput out)
void renderPromptList(MarkupOutput output)
void renderPromptTypeSelector(MarkupOutput out)
void renderSelectorOptions(MarkupOutput out)
void renderTypeInputForMobileURL(MarkupOutput out)
void renderTypeInputForObject(MarkupOutput out)
void renderTypeInputForURL(MarkupOutput out)
void renderURLInput(MarkupOutput out)
Protected Methods
String getScriptClass()

Returns the name of the javaScript class (if any) to be associated with the component.

void renderJavascript(MarkupOutput out)
This method should be used by the Editor transforms to generate any javascript necessary.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
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.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final int STATE_CHANGED

Constant Value: 2 (0x00000002)

public static final int STATE_NEW

Constant Value: 3 (0x00000003)

public static final int STATE_UNCHANGED

Constant Value: 1 (0x00000001)

Public Constructors

public WebHyperLinkEditorTransform ()

Public Methods

public String getDescription ()

Returns a textual description of the transform.

Returns
  • The textual description of the transform.

public String getID ()

Returns 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).

Returns
  • the component's unique id

public Class getSupportedBeanType ()

Returns the supported bean type. This abstract Transform supports all WebComponents so every sub-class should override this method to return the class of the Bean the 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;
    }

 }
 

Returns
  • a root class/interface supported by this transform.

public void initializeTransform (Transformable data)

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

Parameters
data bean that will be transformed

public void renderButtonList (MarkupOutput out)

public void renderEditorContents (MarkupOutput out)

Generates the graphical output for the Editor

Parameters
out MarkupOutput instance where to create the HTML output

public void renderElementSelector (MarkupOutput out)

public void renderFormSelector (MarkupOutput out)

public void renderLinkInfoBegin (MarkupOutput out)

public void renderLinkInfoEnd (MarkupOutput out)

public void renderLinkList (MarkupOutput out)

public void renderLinkName (MarkupOutput out)

public void renderMobileURLSelector (MarkupOutput out)

public void renderObjectSelector (MarkupOutput out)

public void renderOpenInNewWindow (MarkupOutput out)

public void renderPromptList (MarkupOutput output)

public void renderPromptTypeSelector (MarkupOutput out)

public void renderSelectorOptions (MarkupOutput out)

public void renderTypeInputForMobileURL (MarkupOutput out)

public void renderTypeInputForObject (MarkupOutput out)

public void renderTypeInputForURL (MarkupOutput out)

public void renderURLInput (MarkupOutput out)

Protected Methods

protected String getScriptClass ()

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

Returns
  • String representing the name of a javaScript class

protected void renderJavascript (MarkupOutput out)

This method should be used by the Editor transforms to generate any javascript necessary.
The default implementation includes a call to the ClientSideHelper to render the dynamic scrips and the registerBone call.

Parameters
out MarkupOutput where the output should be rendered.