com.ge.research.acuity.ui
Class TextEntryPO

java.lang.Object
  com.ge.research.acuity.ui.PresentationObject
      com.ge.research.acuity.ui.IndependentDisplayPO
          com.ge.research.acuity.ui.InteractionObject
              com.ge.research.acuity.ui.TextEntryPO

public class TextEntryPO

extends InteractionObject

An interaction object that allows for free text entry from the user.

Version:

$Revision: 1.1 $ $Date: 2006/08/11 00:17:24 $

Author:

garbiras

Field Summary

Fields inherited from class com.ge.research.acuity.ui.InteractionObject

CLIENT_EFFECT_LANGUAGE, CLIENT_EFFECT_LOCATION, CLIENT_EFFECT_TYPE

Constructor Summary

TextEntryPO()
Calls the default constructor with null argument

TextEntryPO(java.lang.String statement)
The default constructor.

Method Summary

java.lang.Object	getDefaultValue() Returns the initial value that appears in the text entry element, when rendered by the client
double	getInteractiveTextHeight() Returns the number of rows of the text entry field, to be rendered by the client
double	getInteractiveTextWidth() Returns the visible character width of the text entry field, to be rendered by the client
void	setDefaultValue(java.lang.Object val) Sets the initial value that appears in the text entry element, when rendered by the client
void	setHasPresentationNature(java.lang.String string) Overrides setHasPresentationNature in InteractionObject.
void	setInteractiveTextHeight(double d) Sets the number of rows of the text entry field, to be rendered by the client
void	setInteractiveTextWidth(double d) Sets the visible character width of the text entry field, to be rendered by the client

Methods inherited from class com.ge.research.acuity.ui.InteractionObject

alwaysRefresh, getClientEffects, getOrientation, getPrompt, getValueName, hasOwnSubmit, isDisabled, setAlwaysRefresh, setClientEffects, setHasOwnSubmit, setIsDisabled, setOrientation, setPrompt, setSubmitsOnChange, setValueName, submitsOnChange

Methods inherited from class com.ge.research.acuity.ui.IndependentDisplayPO

canBeRemoved, displayBanner, getHeight, getIdentifierTitle, getWidth, getXPos, getYPos, getZOrder, setCanBeRemoved, setDisplayBanner, setHeight, setIdentifier, setIdentifierTitle, setPos, setPos, setPos, setPos, setWidth, setXPos, setYPos, setZOrder

Methods inherited from class com.ge.research.acuity.ui.PresentationObject

addLookupInfo, getHasPresentationNature, getIdentifier, getLookupInfo, getSubject, hasSubject, isDisplayed, isEditable, setEditability, setIsDisplayed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextEntryPO

public TextEntryPO()

Calls the default constructor with null argument

TextEntryPO

public TextEntryPO(java.lang.String statement)

The default constructor. Calls super(statement), setting the interaction content statement. Sets the presentation nature to PresentationNatureConstants.TEXT

Parameters:

statement - the statement explaining the purpose of this interaction object and content

See Also:

InteractionObject.InteractionObject(java.lang.String), PresentationObject.setHasPresentationNature(java.lang.String)

Method Detail

getDefaultValue

public java.lang.Object getDefaultValue()

Returns the initial value that appears in the text entry element, when rendered by the client

Returns:

The default value rendered within the text entry element in the client

getInteractiveTextHeight

public double getInteractiveTextHeight()

Returns the number of rows of the text entry field, to be rendered by the client

Returns:

The number of rows of the text entry field to be rendered by the client

getInteractiveTextWidth

public double getInteractiveTextWidth()

Returns the visible character width of the text entry field, to be rendered by the client

Returns:

The visible character width of the text entry field to be rendered by the client

setDefaultValue

public void setDefaultValue(java.lang.Object val)

Sets the initial value that appears in the text entry element, when rendered by the client

Parameters:

val - the default value to be rendered within the text entry element in the client

setHasPresentationNature

public void setHasPresentationNature(java.lang.String string)

Overrides setHasPresentationNature in InteractionObject. Checks that the new value for presentation nature is a valid type for a TextEntryPO. If not, the value of presentation nature does not change.

Overrides:

setHasPresentationNature in class InteractionObject

Parameters:

string - the new value of presentation nature

See Also:

PresentationNatureConstants.isGraphType(java.lang.String)

setInteractiveTextHeight

public void setInteractiveTextHeight(double d)

Sets the number of rows of the text entry field, to be rendered by the client

Parameters:

d - the number of rows of the text entry field to be rendered by the client

setInteractiveTextWidth

public void setInteractiveTextWidth(double d)

Sets the visible character width of the text entry field, to be rendered by the client

Parameters:

d - the visible character width of the text entry field to be rendered by the client