|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectUICommand
com.businessobjects.jsf.sdk.components.UIBaseControl
com.businessobjects.jsf.sdk.components.UILogon
Enables a user to log on to a Crystal Enterprise session.
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 |
public static java.lang.String TYPE
For internal use only.
Constructor Detail |
public UILogon()
Method Detail |
public void setLocale(java.util.Locale locale)
Sets the locale setting used to display all text and formatting generated by the Logon component.
setLocale
in class UIBaseControl
locale
- The component's locale.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
.
setAutoHandleEvents
in class UIBaseControl
autoHandleEvents
- true
if the component will react to its own events using a built-in event handler, otherwise, false
.public IIdentity getIdentity()
Gets the IIdentity
object that is bound to the Logon
component.
IIdentity
object.public void setIdentity(IIdentity value)
Binds an IIdentity
object to the Logon
component.
value
- An IIdentity
object to be bound to the Logon component.public java.lang.String getUserNameText()
Gets the text to display for the user name input label.
String
that represents the text to display for the user name input label.public void setUserNameText(java.lang.String userNameText)
Sets the text to display for the user name input label.
userNameText
- A String
that represents the text to display for the user name input label.public java.lang.String getPasswordText()
Gets the text to display for the password input label.
String
that represents the text to display for the password input label.public void setPasswordText(java.lang.String passwordText)
Sets the text to display for the password input label.
passwordText
- A String
that represents the text to display for the password input label.public int getLabelAlignment()
Gets the alignment of the label. See HorizontalAlign
for alignment options.
String
that represents the text to display for the password input label.public void setLabelAlignment(int labelAlignment)
Sets the alignment of the label. See HorizontalAlign
for alignment options.
labelAlignment
- An int
that represents the alignment of the label.public AuthenticationProps getAuthentication()
Gets an instance of the AuthenticationProps
class that determines how
the authentication input field is displayed in the Logon component.
AuthenticationProps
object.public void setAuthentication(AuthenticationProps authentication)
Sets how the authentication input field is displayed in the Logon component.
authentication
- An AuthenticationProps
object that specifies the authentication properties.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.
SystemProps
object.public void setSystem(SystemProps system)
Sets how to display the Crystal Enterprise system input field in the Logon component.
system
- A SystemProps
object that specifies how to display the Crystal Enterprise system input field.public SubmitButtonProps getLogonButton()
Gets an instance of the SubmitButtonProps
class that specifies the properties of the logon button,
including optional button properties.
SubmitButtonProps
object.public void setLogonButton(SubmitButtonProps logonButton)
Sets the properties of the logon button, including optional button properties.
logonButton
- A SubmitButtonProps
object that specifies the properties of the logon button.public SubmitButtonProps getLogoffButton()
Gets an instance of the SubmitButtonProps
class that specifies the properties of the logoff button,
including optional button properties.
SubmitButtonProps
object.public void setLogoffButton(SubmitButtonProps logoffButton)
Sets the properties of the logoff button, including optional button properties.
public void decode(FacesContext context)
For internal use only.
public void submit(IIdentity identity)
Attempts to log the user on or off Crystal Enterprise depending on the state of the component.
public java.lang.String getFamily()
For internal use only.
public java.lang.Object saveState(FacesContext context)
For internal use only.
public void restoreState(FacesContext context, java.lang.Object state)
For internal use only.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |