com.businessobjects.jsf.sdk.components
Class UILogon

java.lang.Object
  extended byUICommand
      extended bycom.businessobjects.jsf.sdk.components.UIBaseControl
          extended bycom.businessobjects.jsf.sdk.components.UILogon

public class UILogon
extends UIBaseControl

Enables a user to log on to a Crystal Enterprise session.

See Also:
Serialized Form

Field Summary
static java.lang.String TYPE
          For internal use only.
 
Constructor Summary
UILogon()
           
 
Method Summary
 void decode(FacesContext context)
           For internal use only.
 AuthenticationProps getAuthentication()
           Gets an instance of the AuthenticationProps class that determines how the authentication input field is displayed in the Logon component.
 java.lang.String getFamily()
           For internal use only.
 IIdentity getIdentity()
           Gets the IIdentity object that is bound to the Logon component.
 int getLabelAlignment()
           Gets the alignment of the label.
 SubmitButtonProps getLogoffButton()
           Gets an instance of the SubmitButtonProps class that specifies the properties of the logoff button, including optional button properties.
 SubmitButtonProps getLogonButton()
           Gets an instance of the SubmitButtonProps class that specifies the properties of the logon button, including optional button properties.
 java.lang.String getPasswordText()
           Gets the text to display for the password input label.
 SystemProps getSystem()
           Gets an instance of the SystemProps class that determines how to display the Crystal Enterprise system input field in the Logon component.
 java.lang.String getUserNameText()
           Gets the text to display for the user name input label.
 void restoreState(FacesContext context, java.lang.Object state)
           For internal use only.
 java.lang.Object saveState(FacesContext context)
           For internal use only.
 void setAuthentication(AuthenticationProps authentication)
           Sets how the authentication input field is displayed in the Logon component.
 void setAutoHandleEvents(boolean autoHandleEvents)
           Sets a value indicating whether the Logon component assumes responsibility for handling its own events.
 void setIdentity(IIdentity value)
           Binds an IIdentity object to the Logon component.
 void setLabelAlignment(int labelAlignment)
           Sets the alignment of the label.
 void setLocale(java.util.Locale locale)
           Sets the locale setting used to display all text and formatting generated by the Logon component.
 void setLogoffButton(SubmitButtonProps logoffButton)
           Sets the properties of the logoff button, including optional button properties.
 void setLogonButton(SubmitButtonProps logonButton)
           Sets the properties of the logon button, including optional button properties.
 void setPasswordText(java.lang.String passwordText)
           Sets the text to display for the password input label.
 void setSystem(SystemProps system)
           Sets how to display the Crystal Enterprise system input field in the Logon component.
 void setUserNameText(java.lang.String userNameText)
           Sets the text to display for the user name input label.
 void submit(IIdentity identity)
           Attempts to log the user on or off Crystal Enterprise depending on the state of the component.
 
Methods inherited from class com.businessobjects.jsf.sdk.components.UIBaseControl
getItemSource, getLocale, isAutoHandleEvents, isEnabled, setEnabled, setItemSource
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TYPE

public static java.lang.String TYPE

For internal use only.

Constructor Detail

UILogon

public UILogon()
Method Detail

setLocale

public void setLocale(java.util.Locale locale)

Sets the locale setting used to display all text and formatting generated by the Logon component.

Overrides:
setLocale in class UIBaseControl
Parameters:
locale - The component's locale.

setAutoHandleEvents

public void setAutoHandleEvents(boolean autoHandleEvents)

Sets a value indicating whether the Logon component assumes responsibility for handling its own events. Pass in true if the control will react to its own events using a built-in event handler, otherwise, set to false.

Overrides:
setAutoHandleEvents in class UIBaseControl
Parameters:
autoHandleEvents - true if the component will react to its own events using a built-in event handler, otherwise, false.

getIdentity

public IIdentity getIdentity()

Gets the IIdentity object that is bound to the Logon component.

Returns:
An IIdentity object.

setIdentity

public void setIdentity(IIdentity value)

Binds an IIdentity object to the Logon component.

Parameters:
value - An IIdentity object to be bound to the Logon component.

getUserNameText

public java.lang.String getUserNameText()

Gets the text to display for the user name input label.

Returns:
A String that represents the text to display for the user name input label.

setUserNameText

public void setUserNameText(java.lang.String userNameText)

Sets the text to display for the user name input label.

Parameters:
userNameText - A String that represents the text to display for the user name input label.

getPasswordText

public java.lang.String getPasswordText()

Gets the text to display for the password input label.

Returns:
A String that represents the text to display for the password input label.

setPasswordText

public void setPasswordText(java.lang.String passwordText)

Sets the text to display for the password input label.

Parameters:
passwordText - A String that represents the text to display for the password input label.

getLabelAlignment

public int getLabelAlignment()

Gets the alignment of the label. See HorizontalAlign for alignment options.

Returns:
A String that represents the text to display for the password input label.

setLabelAlignment

public void setLabelAlignment(int labelAlignment)

Sets the alignment of the label. See HorizontalAlign for alignment options.

Parameters:
labelAlignment - An int that represents the alignment of the label.

getAuthentication

public AuthenticationProps getAuthentication()

Gets an instance of the AuthenticationProps class that determines how the authentication input field is displayed in the Logon component.

Returns:
An AuthenticationProps object.

setAuthentication

public void setAuthentication(AuthenticationProps authentication)

Sets how the authentication input field is displayed in the Logon component.

Parameters:
authentication - An AuthenticationProps object that specifies the authentication properties.

getSystem

public SystemProps getSystem()

Gets an instance of the SystemProps class that determines how to display the Crystal Enterprise system input field in the Logon component.

Returns:
A SystemProps object.

setSystem

public void setSystem(SystemProps system)

Sets how to display the Crystal Enterprise system input field in the Logon component.

Parameters:
system - A SystemProps object that specifies how to display the Crystal Enterprise system input field.

getLogonButton

public SubmitButtonProps getLogonButton()

Gets an instance of the SubmitButtonProps class that specifies the properties of the logon button, including optional button properties.

Returns:
A SubmitButtonProps object.

setLogonButton

public void setLogonButton(SubmitButtonProps logonButton)

Sets the properties of the logon button, including optional button properties.

Parameters:
logonButton - A SubmitButtonProps object that specifies the properties of the logon button.

getLogoffButton

public SubmitButtonProps getLogoffButton()

Gets an instance of the SubmitButtonProps class that specifies the properties of the logoff button, including optional button properties.

Returns:
A SubmitButtonProps object.

setLogoffButton

public void setLogoffButton(SubmitButtonProps logoffButton)

Sets the properties of the logoff button, including optional button properties.


decode

public void decode(FacesContext context)

For internal use only.


submit

public void submit(IIdentity identity)

Attempts to log the user on or off Crystal Enterprise depending on the state of the component.


getFamily

public java.lang.String getFamily()

For internal use only.


saveState

public java.lang.Object saveState(FacesContext context)

For internal use only.


restoreState

public void restoreState(FacesContext context,
                         java.lang.Object state)

For internal use only.