public class

LoginXHTMLTransform

extends LoginTransform
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.LoginTransform
				↳	com.microstrategy.web.app.transforms.LoginXHTMLTransform

Class Overview

This transform renders the login dialog to the user, displaying the different options according to what the Administrator has marked as enabled for users given the IServer and Project selected. It extends the LoginTransform by generating well-formed XHTML, supporting layout-xml, and using external css files for all formatting.

Summary

[Expand]

Inherited Constants

From class com.microstrategy.web.app.transforms.LoginTransform

From class com.microstrategy.web.app.transforms.AbstractAppTransform

[Expand]

Inherited Fields

From class com.microstrategy.web.app.transforms.LoginTransform

From class com.microstrategy.web.app.transforms.AbstractAppTransform

protected final String	CLASS_INPUT	This field is deprecated. This property is not used anymore by the transform.
protected final String	CLASS_MESSAGE	This field is deprecated. This property is not used anymore by the transform.
protected WebComponent	_bean	Instance of `WebComponent` being transformed.
protected ComponentBlock	_componentBlock
protected String	_cssPrefix	Property corresponding to the value of the `cssPrefix` formal parameter
protected String	_imgBlank	Field that containts the URL location of a blank image (used as the source of most <IMG> tags as the real URL is specified through css).
protected String	_imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected MarkupOutput	_selfOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
protected MarkupOutput	_subOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
public FormalParameter	appliesTo	This parameter informs the javascript the id of the bone the actions of this component applies to.
public FormalParameter	contextMenus	This formal parameter is used by the Transform to identify the context-menus definition.
public FormalParameter	cssFile	CSS file that includes the style definition.
public FormalParameter	cssPrefix	Prefix to append to all css class names.
public FormalParameter	debugErrorFlags	Indicates which extra debug information to include in case of an error.
public FormalParameter	debugFlags	Indicates which debug information to include.
public FormalParameter	dragMode	Indicates the drag mode that the component to render will have.
public FormalParameter	extraInput	Indicates any extra inputs to be included in the forms generated by the transform.
public FormalParameter	extraUrl	Indicates any extra parameters to be included in the links generated by the transform.
public FormalParameter	globalCssErrorMessage	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	globalCssErrorTitle	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	height	Indicates the default height of the component.
public FormalParameter	iframeEnabled	Indicates whether the transform supports iframe manipulations.
public FormalParameter	imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected int	indent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
public FormalParameter	initialIndent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
protected boolean	isDHTML	This field is deprecated. Use `isDhtml()`.
public FormalParameter	orientation	Indicates the orientation the dialog to render will have.
public FormalParameter	orientationsAllowed	Indicates the orientation modes allowed for the dialog to render.
public FormalParameter	partialIframeUpdate	This formal parameter specifies whether we should replace the whole contentst of the div shell (outerHTML) or the just the inner contents (innerHTML) of that shell div for the transform when the iframe update is going on.
public FormalParameter	processingButtonsFlags	Indicates which buttons to include on the wait page.
public FormalParameter	processingInfoFlags	Indicates which information to include on the wait page.
public FormalParameter	resizeLevel	Indicates whether the component can be resized vertically/horizontally or both or none.
public FormalParameter	scriptClass	Holds the name of the javaScript class (if any) to be associated with the component.
protected static final ScriptVariableJSONEncoder	scriptEndTagEncoder	reference to encoder that deals with tag encoding
public FormalParameter	type	This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is.
public FormalParameter	useDHTML	Indicates whether to use DHTML on the output.
public FormalParameter	width	Indicates the default width of the component.

Public Constructors
	LoginXHTMLTransform() Default constructor, initializes formal parameters.

Public Methods
void	renderCancelButton(MarkupOutput out) Generates the HTML output for displaying a Cancel button to the user for cancelling the login request.
void	renderFacebookAuthenticationLink(MarkupOutput out, WebEvent event)
void	renderGuestAuthenticationLink(MarkupOutput out, WebEvent event) Render the link for guest authentication to show to users for log into a project.
void	renderKerberosAuthenticationLink(MarkupOutput out, WebEvent event) Render the link for Kerberos authentication to show to users for log into a project.
void	renderLoginButton(MarkupOutput out) Generates the HTML to present the user with the button for submitting a login request.
void	renderLoginDialog(MarkupOutput out) Render the actual login dialog.
void	renderLoginDialogFooter(MarkupOutput out) Render the footer for the login dialog box.
void	renderLoginDialogHeader(MarkupOutput out) Render the header for the login dialog box.
void	renderLoginModeToggle(MarkupOutput out)
void	renderNTGuestLoginSection(MarkupOutput out) Generates the HTML to present the user with the options for logging into a project with NT and/or Guest and/or Kerberos authentication modes, according to what the Administrator enabled.
void	renderPassword(LoginBean bean, WebEvent loginEvent, Tag divTag)
void	renderSSPAuthenticationLink(MarkupOutput out, WebEvent event)
void	renderStandardLoginSection(MarkupOutput out) Generates the HTML to present the user with the options for logging into a project with the authentication modes that require entering user name and password, according to what the Administrator enabled.
void	renderTwoStepVerificationCodeOption(WebEvent loginEvent, Tag divTag, boolean visible)
void	renderUserName(LoginBean bean, WebEvent loginEvent, Tag auxDivTag)
void	renderUsherLogin(MarkupOutput out) responsible for rendering the html where the QR code will be loaded by the Javascript
void	renderUsherLoginHiddenForm(MarkupOutput out, WebEvent event) Generate usher login form
void	renderUsherLoginPlaceholder(MarkupOutput out)
void	renderWindowsAuthenticationLink(MarkupOutput out, WebEvent event) Render the link for Windows (NT) authentication to show to users for log into a project.
void	transformForRequestSuccessful(MarkupOutput out) Generates the graphical output for the `LoginBean` instance being transformed, when it's state is `WebBeanRequestSuccessful`.

Protected Methods
AnchorTag	generateAnchor(WebEvent event) Overwrites the parent method by setting special attributes according to the event provided.

[Expand]

Inherited Methods

From class com.microstrategy.web.app.transforms.LoginTransform

From class com.microstrategy.web.app.transforms.AbstractAppTransform

From class com.microstrategy.web.transform.AbstractLayoutTransform

From class com.microstrategy.web.transform.AbstractTransform

void	addFormalParam(FormalParameterImpl formal) This method is used to add a `FormalParameterImpl` object to the transform.
boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
static List<Integer>	getEvents(RequestKeys rkeys) Determines event(s) triggered from the request keys.
FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
String	getID() Returns the unique name of the component to be used as the ID for its shell
MarkupOutput	getPreview() Produces a preview output for this transform.
boolean	isPreviewAvailable() Returns true if this transform supports preview functionality, false otherwise.
boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
FormalParameterImpl	removeFormalParam(String name) Removes the formal parameter with the given name from the formal parameters collection.
void	setAnnotation(FormalParameter fp, FormalParameterAnnotation fpa) Used for internal housekeeping.
void	setDeprecated(FormalParameter fp, String desc) Used for internal housekeeping.
boolean	supports(Class type) Returns true if the transform supports objects of specified type.
boolean	supports(Transformable data) Returns true if the transform supports the specified data object.

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

abstract boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
abstract String	getDescription() Returns a textual description of the transform.
abstract FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
abstract String	getID() Returns the unique name of the component to be used as the ID for its shell
abstract MarkupOutput	getPreview() This method is deprecated. This feature is not used
abstract Class	getSupportedBeanType() Returns a root class/interface supported by this transform.
abstract boolean	isPreviewAvailable() This method is deprecated. This feature is not used
abstract boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
abstract boolean	supports(Class beanClass) Returns true if the transform supports objects of specified type.
abstract boolean	supports(Transformable data) Returns true if the transform supports the specified data object.
abstract void	transform(Transformable data, MarkupOutput transOut) Transforms the data object and appends result to the transOut.

Public Constructors

public LoginXHTMLTransform ()

Default constructor, initializes formal parameters.

Public Methods

public void renderCancelButton (MarkupOutput out)

Generates the HTML output for displaying a Cancel button to the user for cancelling the login request.

Parameters

out	`MarkupOutput` instance where to save the contents to render

public void renderFacebookAuthenticationLink (MarkupOutput out, WebEvent event)

public void renderGuestAuthenticationLink (MarkupOutput out, WebEvent event)

Render the link for guest authentication to show to users for log into a project. Overwrites the parent method by generating the information as a FORM with a button with the information for submitting a guest authentication request.

Parameters

out	a `MarkupOutput` instance where to save the HTML to render
event	a `WebEvent` instance with the details to be used when creating the link for this authentication mode

public void renderKerberosAuthenticationLink (MarkupOutput out, WebEvent event)

Render the link for Kerberos authentication to show to users for log into a project.

Parameters

out	a `MarkupOutput` instance where to save the HTML to render
event	a `WebEvent` instance with the details to be used when creating the link for this authentication mode

public void renderLoginButton (MarkupOutput out)

Generates the HTML to present the user with the button for submitting a login request.

Parameters

out	`MarkupOutput` instance where to save the contents to render

public void renderLoginDialog (MarkupOutput out)

Render the actual login dialog. It will present the user the different login options depending on what the Administrator has enabled. Overwrites the parent method by generating the output as a series of DIV, SPAN and other HTML tags instead of contents of a table.

Parameters

out	`MarkupOutput` instance where to save the contents to render

public void renderLoginDialogFooter (MarkupOutput out)

Render the footer for the login dialog box. Overwrites the parent method by not rendering any information.

Parameters

out	`MarkupOutput` instance where to save the contents to render

public void renderLoginDialogHeader (MarkupOutput out)

Render the header for the login dialog box. Overwrites the parent method by generating the output as a series of DIV and SPAN HTML tags instead of contents of a table.

Parameters

out	`MarkupOutput` instance where to save the contents to render

public void renderLoginModeToggle (MarkupOutput out)

public void renderNTGuestLoginSection (MarkupOutput out)

Generates the HTML to present the user with the options for logging into a project with NT and/or Guest and/or Kerberos authentication modes, according to what the Administrator enabled. Overwrites the parent method by generating the output as a series of DIV, SPAN and other HTML tags instead of contents of a table.

Parameters

out	`MarkupOutput` instance where to save the contents to render

public void renderPassword (LoginBean bean, WebEvent loginEvent, Tag divTag)

public void renderSSPAuthenticationLink (MarkupOutput out, WebEvent event)

public void renderStandardLoginSection (MarkupOutput out)

Generates the HTML to present the user with the options for logging into a project with the authentication modes that require entering user name and password, according to what the Administrator enabled. Typically, this will render Standard, Pass-Through and LDAP authentication modes. Overwrites the parent method by generating the output as a series of DIV, SPAN and other HTML tags instead of contents of a table.

Parameters

out	`MarkupOutput` instance where to save the contents to render

public void renderTwoStepVerificationCodeOption (WebEvent loginEvent, Tag divTag, boolean visible)

public void renderUserName (LoginBean bean, WebEvent loginEvent, Tag auxDivTag)

public void renderUsherLogin (MarkupOutput out)

responsible for rendering the html where the QR code will be loaded by the Javascript

public void renderUsherLoginHiddenForm (MarkupOutput out, WebEvent event)

Generate usher login form

public void renderUsherLoginPlaceholder (MarkupOutput out)

public void renderWindowsAuthenticationLink (MarkupOutput out, WebEvent event)

Render the link for Windows (NT) authentication to show to users for log into a project. Overwrites the parent method by generating the information as a FORM with a button with the information for submitting a windows authentication request.

Parameters

out	a `MarkupOutput` instance where to save the HTML to render
event	a `WebEvent` instance with the details to be used when creating the link for this authentication mode

public void transformForRequestSuccessful (MarkupOutput out)

Generates the graphical output for the LoginBean instance being transformed, when it's state is WebBeanRequestSuccessful.

Parameters

out	`MarkupOutput` instance where to create the HTML output

Protected Methods

protected AnchorTag generateAnchor (WebEvent event)

Overwrites the parent method by setting special attributes according to the event provided.

Parameters

event	`WebEvent` instance with the information from where the anchor will be created

Returns

an AnchorTag instance initialized with the information from the event for enabling the user to submit a request.

Interfaces

Classes

LoginXHTMLTransform

Class Overview

Summary

Public Constructors

public LoginXHTMLTransform ()

Public Methods

public void renderCancelButton (MarkupOutput out)

Parameters

public void renderFacebookAuthenticationLink (MarkupOutput out, WebEvent event)

public void renderGuestAuthenticationLink (MarkupOutput out, WebEvent event)

Parameters

public void renderKerberosAuthenticationLink (MarkupOutput out, WebEvent event)

Parameters

public void renderLoginButton (MarkupOutput out)

Parameters

public void renderLoginDialog (MarkupOutput out)

Parameters

public void renderLoginDialogFooter (MarkupOutput out)

Parameters

public void renderLoginDialogHeader (MarkupOutput out)

Parameters

public void renderLoginModeToggle (MarkupOutput out)

public void renderNTGuestLoginSection (MarkupOutput out)

Parameters

public void renderPassword (LoginBean bean, WebEvent loginEvent, Tag divTag)

public void renderSSPAuthenticationLink (MarkupOutput out, WebEvent event)

public void renderStandardLoginSection (MarkupOutput out)

Parameters

public void renderTwoStepVerificationCodeOption (WebEvent loginEvent, Tag divTag, boolean visible)

public void renderUserName (LoginBean bean, WebEvent loginEvent, Tag auxDivTag)

public void renderUsherLogin (MarkupOutput out)

public void renderUsherLoginHiddenForm (MarkupOutput out, WebEvent event)

public void renderUsherLoginPlaceholder (MarkupOutput out)

public void renderWindowsAuthenticationLink (MarkupOutput out, WebEvent event)

Parameters

public void transformForRequestSuccessful (MarkupOutput out)

Parameters

Protected Methods

protected AnchorTag generateAnchor (WebEvent event)

Parameters

Returns