LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.view
Class LyTextBase

java.lang.Object
  extended by leon.view.LyComponent
      extended by leon.view.LyFieldItem
          extended by leon.view.LyTextBase
All Implemented Interfaces:
LyGetIdInterface, LyGetLabelInterface, LySetLabelInterface, LyUpdateViewContentInterface
Direct Known Subclasses:
LyText

public abstract class LyTextBase
extends LyFieldItem
implements LyGetIdInterface, LyGetLabelInterface, LySetLabelInterface

The LyTextBase class is a generated Java implementation that corresponds to the element TEXT of the descriptive grammar of the views (views.dtd). <TEXT> : Input Field of Text Type An input field of Text type allows displaying a graphical input or text consultation component. It does not comprise any element. It is possible to specify if the text should be hidden, if it should respect a given format, if it can be divided into several lines and the maximum number of characters that it can contain.

See Also:
LyFieldItem, See also tag TEXT of grammar leon_views.dtd.

Nested Class Summary
static class LyTextBase.Scroll
          Possible values for attribute 'scroll'.
static class LyTextBase.TextAlign
          Possible values for attribute 'textAlign'.
static class LyTextBase.Type
          Possible values for attribute 'type'.
 
Nested classes/interfaces inherited from class leon.view.LyComponent
LyComponent.EventType
 
Field Summary
static java.lang.String __VERSION
           
 
Fields inherited from class leon.view.LyComponent
_nbComponents, INIT_RESOURCE_ID, INTERNAL_ID_SEP, REWRITING_MODE, SEP_ID
 
Constructor Summary
LyTextBase()
          Default constructor.
 
Method Summary
 void addCharType(LyCharType charType)
          Adds a sub-component charType.
 LyComponent cloneComponent()
          Method for cloning a component.
 java.lang.String getArrowDown()
          Gets value of arrowDown.
 java.lang.String getArrowUp()
          Gets value of arrowUp.
 java.lang.String getAutoCompletionValues()
          Gets value of autoCompletionValues.
 java.lang.String getBean()
          Gets value of bean.
 LyCharType getCharType(int i)
          Get sub-component CharType of index i.
 int getCharTypeCount()
          Get sub-component CharType count.
 java.lang.String getDisabledColor()
          Gets value of disabledColor.
 java.lang.String getEnabledColor()
          Gets value of enabledColor.
 java.lang.String getFont()
          Gets value of font.
 java.lang.String getFontColor()
          Gets value of fontColor.
 java.lang.String getFormat()
          Gets value of format.
 java.lang.String getId()
          Gets value of id.
 java.lang.String getLabel()
          Gets value of label.
 int getNChars()
          Gets value of nChars.
 int getNCols()
          Gets value of nCols.
 int getNRows()
          Gets value of nRows.
 LyTextBase.Scroll getScroll()
          Gets value of scroll.
static LyTextBase.Scroll getScroll(java.lang.String token)
          Utility method to get scroll value from a string.
 LyText getTemplate()
          Gets value of template.
 LyTextBase.TextAlign getTextAlign()
          Gets value of textAlign.
static LyTextBase.TextAlign getTextAlign(java.lang.String token)
          Utility method to get textAlign value from a string.
 LyTextBase.Type getType()
          Gets value of type.
static LyTextBase.Type getType(java.lang.String token)
          Utility method to get type value from a string.
 void insertCharType(LyCharType charType, int pos)
          Inserts a sub-component charType at given position.
 boolean isArrows()
          Checks if value of attribute arrows is set.
 boolean isDefaultArrowDown()
          Checks whether the arrowDown attribute is valuated to the default value.
 boolean isDefaultArrowUp()
          Checks whether the arrowUp attribute is valuated to the default value.
 boolean isDefaultDisabledColor()
          Checks whether the disabledColor attribute is valuated to the default value.
 boolean isDefaultEnabledColor()
          Checks whether the enabledColor attribute is valuated to the default value.
 boolean isDefaultFont()
          Checks whether the font attribute is valuated to the default value.
 boolean isDefaultFontColor()
          Checks whether the fontColor attribute is valuated to the default value.
 boolean isEditable()
          Checks if value of attribute editable is set.
 boolean isNotifyValueChanged()
          Checks if value of attribute notifyValueChanged is set.
 boolean isSecret()
          Checks if value of attribute secret is set.
 boolean isWrap()
          Checks if value of attribute wrap is set.
 void setArrowDown(java.lang.String arrowDown)
          Initializes attribute arrowDown to the given value.
 void setArrows(boolean arrows)
          Initializes attribute arrows to the given value.
 void setArrowUp(java.lang.String arrowUp)
          Initializes attribute arrowUp to the given value.
 void setAutoCompletionValues(java.lang.String autoCompletionValues)
          Initializes attribute autoCompletionValues to the given value.
 void setBean(java.lang.String bean)
          Initializes attribute bean to the given value.
 void setDisabledColor(java.lang.String disabledColor)
          Initializes attribute disabledColor to the given value.
 void setEditable(boolean editable)
          Initializes attribute editable to the given value.
 void setEnabledColor(java.lang.String enabledColor)
          Initializes attribute enabledColor to the given value.
 void setFont(java.lang.String font)
          Initializes attribute font to the given value.
 void setFontColor(java.lang.String fontColor)
          Initializes attribute fontColor to the given value.
 void setFormat(java.lang.String format)
          Initializes attribute format to the given value.
 void setId(java.lang.String id)
          Initializes attribute id to the given value.
 void setLabel(java.lang.String label)
          Sets attribute label to the given value.
 void setNChars(int nChars)
          Initializes attribute nChars to the given value.
 void setNCols(int nCols)
          Initializes attribute nCols to the given value.
 void setNotifyValueChanged(boolean notifyValueChanged)
          Initializes attribute notifyValueChanged to the given value.
 void setNRows(int nRows)
          Initializes attribute nRows to the given value.
 void setScroll(LyTextBase.Scroll scroll)
          Initializes attribute scroll to the given value.
 void setSecret(boolean secret)
          Initializes attribute secret to the given value.
 void setTemplate(LyText template)
          Initializes attribute template to the given value.
 void setTextAlign(LyTextBase.TextAlign textAlign)
          Initializes attribute textAlign to the given value.
 void setType(LyTextBase.Type type)
          Initializes attribute type to the given value.
 void setWrap(boolean wrap)
          Initializes attribute wrap to the given value.
 void writeXml(java.io.PrintWriter pw, boolean debug)
          Method to rewrite XML corresponding to this component.
 
Methods inherited from class leon.view.LyFieldItem
addBeanData, buildBean, free, getBeanComponent, getBeanData, getBeanDatas, getChild, getChildCount, getErrorMessage, getFieldValue, getValue, setBeanComponent, setBeanDatas, setFieldValue, updateViewContent, validateInput
 
Methods inherited from class leon.view.LyComponent
addComponent, addData, addEventFunction, clearChildrenBounds, freeze, getBounds, getChildFromCache, getChildrenBounds, getComponent, getComponent, getComponent, getComponent, getComponent, getComponentAt, getComponentAt, getComponentByInternalId, getComponentByLabel, getComponents, getComponentWithModel, getData, getDatas, getEnvironment, getEventFunctions, getIdCode, getInternalId, getInternalView, getInternalView, getLock, getModel, getParent, getParentArea, getParentForm, getParentFormFieldId, getParentSplitter, getParentSplitter, getParentTab, getParentTab, getParentTabs, getParentTabs, getParentView, getRootController, getSetVisibleParent, getTag, getViewManager, isFreed, isFreeing, registerChildrenBounds, removeComponent, reset, resetChildrenCache, resetEventFunctions, setDatas, setInternalView, setVisible, useEventDefaultFunction, writeXml
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

__VERSION

public static final java.lang.String __VERSION
See Also:
Constant Field Values
Constructor Detail

LyTextBase

public LyTextBase()
Default constructor.

Method Detail

getTextAlign

public static final LyTextBase.TextAlign getTextAlign(java.lang.String token)
Utility method to get textAlign value from a string.

Parameters:
token - Token string
Returns:
TextAlign value corresponding to this token

getType

public static final LyTextBase.Type getType(java.lang.String token)
Utility method to get type value from a string.

Parameters:
token - Token string
Returns:
Type value corresponding to this token

getScroll

public static final LyTextBase.Scroll getScroll(java.lang.String token)
Utility method to get scroll value from a string.

Parameters:
token - Token string
Returns:
Scroll value corresponding to this token

cloneComponent

public LyComponent cloneComponent()
Method for cloning a component.

Specified by:
cloneComponent in class LyComponent

getId

public java.lang.String getId()
Gets value of id.

Specified by:
getId in interface LyGetIdInterface
Overrides:
getId in class LyComponent
Returns:
value of id.

getTemplate

public LyText getTemplate()
Gets value of template.

Returns:
value of template.

getLabel

public java.lang.String getLabel()
Gets value of label.

Specified by:
getLabel in interface LyGetLabelInterface
Returns:
value of label.

isSecret

public boolean isSecret()
Checks if value of attribute secret is set.

Returns:
true if secret is set, false otherwise.

getNCols

public int getNCols()
Gets value of nCols.

Returns:
value of nCols.

getNRows

public int getNRows()
Gets value of nRows.

Returns:
value of nRows.

getNChars

public int getNChars()
Gets value of nChars.

Returns:
value of nChars.

getFormat

public java.lang.String getFormat()
Gets value of format.

Returns:
value of format.

isEditable

public boolean isEditable()
Checks if value of attribute editable is set.

Returns:
true if editable is set, false otherwise.

isWrap

public boolean isWrap()
Checks if value of attribute wrap is set.

Returns:
true if wrap is set, false otherwise.

isNotifyValueChanged

public boolean isNotifyValueChanged()
Checks if value of attribute notifyValueChanged is set.

Returns:
true if notifyValueChanged is set, false otherwise.

getAutoCompletionValues

public java.lang.String getAutoCompletionValues()
Gets value of autoCompletionValues.

Returns:
value of autoCompletionValues.

getBean

public java.lang.String getBean()
Gets value of bean.

Overrides:
getBean in class LyFieldItem
Returns:
value of bean.

getFont

public java.lang.String getFont()
Gets value of font.

Returns:
value of font.

isDefaultFont

public boolean isDefaultFont()
Checks whether the font attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getEnabledColor

public java.lang.String getEnabledColor()
Gets value of enabledColor.

Returns:
value of enabledColor.

isDefaultEnabledColor

public boolean isDefaultEnabledColor()
Checks whether the enabledColor attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getDisabledColor

public java.lang.String getDisabledColor()
Gets value of disabledColor.

Returns:
value of disabledColor.

isDefaultDisabledColor

public boolean isDefaultDisabledColor()
Checks whether the disabledColor attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getFontColor

public java.lang.String getFontColor()
Gets value of fontColor.

Returns:
value of fontColor.

isDefaultFontColor

public boolean isDefaultFontColor()
Checks whether the fontColor attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getTextAlign

public LyTextBase.TextAlign getTextAlign()
Gets value of textAlign.

Returns:
value of textAlign.

isArrows

public boolean isArrows()
Checks if value of attribute arrows is set.

Returns:
true if arrows is set, false otherwise.

getArrowUp

public java.lang.String getArrowUp()
Gets value of arrowUp.

Returns:
value of arrowUp.

isDefaultArrowUp

public boolean isDefaultArrowUp()
Checks whether the arrowUp attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getArrowDown

public java.lang.String getArrowDown()
Gets value of arrowDown.

Returns:
value of arrowDown.

isDefaultArrowDown

public boolean isDefaultArrowDown()
Checks whether the arrowDown attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getType

public LyTextBase.Type getType()
Gets value of type.

Returns:
value of type.

getScroll

public LyTextBase.Scroll getScroll()
Gets value of scroll.

Returns:
value of scroll.

getCharType

public LyCharType getCharType(int i)
Get sub-component CharType of index i.

Parameters:
i - the index of the CharType to get.
Returns:
sub-component CharType of index i.

getCharTypeCount

public int getCharTypeCount()
Get sub-component CharType count.

Returns:
sub-component CharType count.

setId

public void setId(java.lang.String id)
Initializes attribute id to the given value.

Parameters:
id - New value of id.

setTemplate

public void setTemplate(LyText template)
Initializes attribute template to the given value.

Parameters:
template - New value of template.

setLabel

public void setLabel(java.lang.String label)
Sets attribute label to the given value.

Specified by:
setLabel in interface LySetLabelInterface
Overrides:
setLabel in class LyFieldItem
Parameters:
label - New value of label.

setSecret

public void setSecret(boolean secret)
Initializes attribute secret to the given value.

Parameters:
secret - Boolean indicating if attribute secret is set or unset.

setNCols

public void setNCols(int nCols)
Initializes attribute nCols to the given value.

Parameters:
nCols - New value of nCols.

setNRows

public void setNRows(int nRows)
Initializes attribute nRows to the given value.

Parameters:
nRows - New value of nRows.

setNChars

public void setNChars(int nChars)
Initializes attribute nChars to the given value.

Parameters:
nChars - New value of nChars.

setFormat

public void setFormat(java.lang.String format)
Initializes attribute format to the given value.

Parameters:
format - New value of format.

setEditable

public void setEditable(boolean editable)
Initializes attribute editable to the given value.

Parameters:
editable - Boolean indicating if attribute editable is set or unset.

setWrap

public void setWrap(boolean wrap)
Initializes attribute wrap to the given value.

Parameters:
wrap - Boolean indicating if attribute wrap is set or unset.

setNotifyValueChanged

public void setNotifyValueChanged(boolean notifyValueChanged)
Initializes attribute notifyValueChanged to the given value.

Parameters:
notifyValueChanged - Boolean indicating if attribute notifyValueChanged is set or unset.

setAutoCompletionValues

public void setAutoCompletionValues(java.lang.String autoCompletionValues)
Initializes attribute autoCompletionValues to the given value.

Parameters:
autoCompletionValues - New value of autoCompletionValues.

setBean

public void setBean(java.lang.String bean)
Initializes attribute bean to the given value.

Overrides:
setBean in class LyFieldItem
Parameters:
bean - New value of bean.

setFont

public void setFont(java.lang.String font)
Initializes attribute font to the given value.

Parameters:
font - New value of font.

setEnabledColor

public void setEnabledColor(java.lang.String enabledColor)
Initializes attribute enabledColor to the given value.

Parameters:
enabledColor - New value of enabledColor.

setDisabledColor

public void setDisabledColor(java.lang.String disabledColor)
Initializes attribute disabledColor to the given value.

Parameters:
disabledColor - New value of disabledColor.

setFontColor

public void setFontColor(java.lang.String fontColor)
Initializes attribute fontColor to the given value.

Parameters:
fontColor - New value of fontColor.

setTextAlign

public void setTextAlign(LyTextBase.TextAlign textAlign)
Initializes attribute textAlign to the given value.

Parameters:
textAlign - New value of textAlign.
Throws:
java.lang.IllegalArgumentException - if textAlign parameter is null.

setArrows

public void setArrows(boolean arrows)
Initializes attribute arrows to the given value.

Parameters:
arrows - Boolean indicating if attribute arrows is set or unset.

setArrowUp

public void setArrowUp(java.lang.String arrowUp)
Initializes attribute arrowUp to the given value.

Parameters:
arrowUp - New value of arrowUp.

setArrowDown

public void setArrowDown(java.lang.String arrowDown)
Initializes attribute arrowDown to the given value.

Parameters:
arrowDown - New value of arrowDown.

setType

public void setType(LyTextBase.Type type)
Initializes attribute type to the given value.

Parameters:
type - New value of type.
Throws:
java.lang.IllegalArgumentException - if type parameter is null.

setScroll

public void setScroll(LyTextBase.Scroll scroll)
Initializes attribute scroll to the given value.

Parameters:
scroll - New value of scroll.
Throws:
java.lang.IllegalArgumentException - if scroll parameter is null.

addCharType

public void addCharType(LyCharType charType)
Adds a sub-component charType.

Parameters:
charType - The charType to add to charTypes list.

insertCharType

public void insertCharType(LyCharType charType,
                           int pos)
Inserts a sub-component charType at given position.

Parameters:
charType - The charType to add to charTypes list.
pos - Position where the sub-component is inserted.

writeXml

public void writeXml(java.io.PrintWriter pw,
                     boolean debug)
Method to rewrite XML corresponding to this component.

Specified by:
writeXml in class LyComponent
Parameters:
pw - the printWriter on which the XML is written.
debug - true if debug mode (full dump).

(c) January 2013 - W4 S.A.

Website: W4 S.A., contact us: support@w4global.com