com.businessobjects.jsf.sdk.components
Class UIBaseControl

java.lang.Object
  |
  +--UICommand
        |
        +--com.businessobjects.jsf.sdk.components.UIBaseControl
Direct Known Subclasses:
UIChangePassword, UIItemsColumn, UIItemsGrid, UILogon, UIPath

public abstract class UIBaseControl
extends UICommand

The base component from which all other BusinessObjects Enterprise JSF components inherit.

See Also:
Serialized Form

Constructor Summary
UIBaseControl()
           
 
Method Summary
 IItemSource getItemSource()
           Gets the source of the item bound to the component.
 java.util.Locale getLocale()
           Gets the component's locale.
 java.lang.String getTitle()
           Gets the title attribute for the component.
 boolean isAutoHandleEvents()
           Returns a value that indicates whether the component assumes responsibility for handling its own events.
 boolean isEnabled()
           Returns a value that indicates whether the component is enabled.
 void restoreState(FacesContext context, java.lang.Object state)
           For internal use only.
 java.lang.Object saveState(FacesContext context)
           For internal use only.
 void setAutoHandleEvents(boolean autoHandleEvents)
           Sets a value that indicates whether the component assumes responsibility for handling its own events.
 void setEnabled(boolean enabled)
           Sets a value that indicates whether the component is enabled.
 void setItemSource(IItemSource itemSource)
           Sets the source of the item to be bound to the component.
 void setLocale(java.util.Locale locale)
           Sets the component's locale.
 void setTitle(java.lang.String title)
           Sets the title attribute for the component.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UIBaseControl

public UIBaseControl()
Method Detail

getItemSource

public IItemSource getItemSource()

Gets the source of the item bound to the component. This is either a EnterpriseItem bean or EntepriseItems bean.

Returns:
An IItemSource object.

setItemSource

public void setItemSource(IItemSource itemSource)

Sets the source of the item to be bound to the component. This can be either a EnterpriseItem bean or EntepriseItems bean.


isEnabled

public boolean isEnabled()

Returns a value that indicates whether the component is enabled. If a component is disabled, then the user cannot change the state of the component (for example, the user cannot enter text or submit new values).

Returns:
true if the component is enabled, otherwise, false.

setEnabled

public void setEnabled(boolean enabled)

Sets a value that indicates whether the component is enabled. If a component is disabled, then the user cannot change the state of the component (for example, the user cannot enter text or submit new values).

Parameters:
enabled - true to enable the component, otherwise, false.

getTitle

public java.lang.String getTitle()

Gets the title attribute for the component. The title attribute is the title visible as a tooltip during mouseover.

Returns:
the title attribute for the component as a String

setTitle

public void setTitle(java.lang.String title)

Sets the title attribute for the component. The title attribute is the title visible as a tooltip during mouseover.

Parameters:
title - the title attribute for the component as a String

getLocale

public java.util.Locale getLocale()

Gets the component's locale.

Returns:
An IItemSource object.

setLocale

public void setLocale(java.util.Locale locale)

Sets the component's locale.

Parameters:
locale - The component's locale.

isAutoHandleEvents

public boolean isAutoHandleEvents()

Returns a value that indicates whether the component assumes responsibility for handling its own events.

Returns:
true if the component will react to its own events using a built-in event handler, otherwise, false.

setAutoHandleEvents

public void setAutoHandleEvents(boolean autoHandleEvents)

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

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

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.