LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.view
Class LyList

java.lang.Object
  extended by leon.view.LyComponent
      extended by leon.view.LyFieldItem
          extended by leon.view.LyList
All Implemented Interfaces:
LyGetIdInterface, LyUpdateViewContentInterface

public class LyList
extends LyFieldItem
implements LyGetIdInterface

The LyList class is a generated Java implementation that corresponds to the element LIST of the descriptive grammar of the views (views.dtd). <LIST> : Input Field of List Type An input field of List type allows choosing one or more values among a discrete list of values. It is possible to specify if the selection is multiple or not as well as the height of the list.

See Also:
See also tag LIST of grammar leon_views.dtd.

Nested Class Summary
static class LyList.SelectionMode
          Possible values for attribute 'selectionMode'.
 
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
LyList()
          Default constructor.
 
Method Summary
 void addListOption(LyListOption listOption)
          Adds a sub-component listOption.
 LyComponent cloneComponent()
          Method for cloning a component.
 java.lang.String getBean()
          Gets value of bean.
 java.lang.String getColor()
          Gets value of color.
 java.lang.String getFont()
          Gets value of font.
 java.lang.String getFontColor()
          Gets value of fontColor.
 java.lang.String getId()
          Gets value of id.
 java.lang.String getInactiveSelectColor()
          Gets value of inactiveSelectColor.
 java.lang.String getInactiveSelectFontColor()
          Gets value of inactiveSelectFontColor.
 LyListOption getListOption(int i)
          Get sub-component ListOption of index i.
 int getListOptionCount()
          Get sub-component ListOption count.
 int getNCols()
          Gets value of nCols.
 int getNRows()
          Gets value of nRows.
 java.lang.String getSelectedColor()
          Gets value of selectedColor.
 java.lang.String getSelectedFontColor()
          Gets value of selectedFontColor.
 LyList.SelectionMode getSelectionMode()
          Gets value of selectionMode.
static LyList.SelectionMode getSelectionMode(java.lang.String token)
          Utility method to get selectionMode value from a string.
 LyList getTemplate()
          Gets value of template.
 java.lang.String getTipColor()
          Gets value of tipColor.
 java.lang.String getTipFont()
          Gets value of tipFont.
 java.lang.String getTipFontColor()
          Gets value of tipFontColor.
 void insertListOption(LyListOption listOption, int pos)
          Inserts a sub-component listOption at given position.
 boolean isDefaultColor()
          Checks whether the color 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 isDefaultInactiveSelectColor()
          Checks whether the inactiveSelectColor attribute is valuated to the default value.
 boolean isDefaultInactiveSelectFontColor()
          Checks whether the inactiveSelectFontColor attribute is valuated to the default value.
 boolean isDefaultSelectedColor()
          Checks whether the selectedColor attribute is valuated to the default value.
 boolean isDefaultSelectedFontColor()
          Checks whether the selectedFontColor attribute is valuated to the default value.
 boolean isDefaultTipColor()
          Checks whether the tipColor attribute is valuated to the default value.
 boolean isDefaultTipFont()
          Checks whether the tipFont attribute is valuated to the default value.
 boolean isDefaultTipFontColor()
          Checks whether the tipFontColor attribute is valuated to the default value.
 void removeListOption(LyListOption listOption)
          Removes a sub-component listOption.
 void setBean(java.lang.String bean)
          Initializes attribute bean to the given value.
 void setColor(java.lang.String color)
          Initializes attribute color 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 setId(java.lang.String id)
          Initializes attribute id to the given value.
 void setInactiveSelectColor(java.lang.String inactiveSelectColor)
          Initializes attribute inactiveSelectColor to the given value.
 void setInactiveSelectFontColor(java.lang.String inactiveSelectFontColor)
          Initializes attribute inactiveSelectFontColor to the given value.
 void setNCols(int nCols)
          Initializes attribute nCols to the given value.
 void setNRows(int nRows)
          Initializes attribute nRows to the given value.
 void setSelectedColor(java.lang.String selectedColor)
          Initializes attribute selectedColor to the given value.
 void setSelectedFontColor(java.lang.String selectedFontColor)
          Initializes attribute selectedFontColor to the given value.
 void setSelectionMode(LyList.SelectionMode selectionMode)
          Initializes attribute selectionMode to the given value.
 void setTemplate(LyList template)
          Initializes attribute template to the given value.
 void setTipColor(java.lang.String tipColor)
          Initializes attribute tipColor to the given value.
 void setTipFont(java.lang.String tipFont)
          Initializes attribute tipFont to the given value.
 void setTipFontColor(java.lang.String tipFontColor)
          Initializes attribute tipFontColor 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, setLabel, 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

LyList

public LyList()
Default constructor.

Method Detail

getSelectionMode

public static final LyList.SelectionMode getSelectionMode(java.lang.String token)
Utility method to get selectionMode value from a string.

Parameters:
token - Token string
Returns:
SelectionMode 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 LyList getTemplate()
Gets value of template.

Returns:
value of template.

getSelectionMode

public LyList.SelectionMode getSelectionMode()
Gets value of selectionMode.

Returns:
value of selectionMode.

getNCols

public int getNCols()
Gets value of nCols.

Returns:
value of nCols.

getNRows

public int getNRows()
Gets value of nRows.

Returns:
value of nRows.

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.

getColor

public java.lang.String getColor()
Gets value of color.

Returns:
value of color.

isDefaultColor

public boolean isDefaultColor()
Checks whether the color 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.

getTipFont

public java.lang.String getTipFont()
Gets value of tipFont.

Returns:
value of tipFont.

isDefaultTipFont

public boolean isDefaultTipFont()
Checks whether the tipFont attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getTipColor

public java.lang.String getTipColor()
Gets value of tipColor.

Returns:
value of tipColor.

isDefaultTipColor

public boolean isDefaultTipColor()
Checks whether the tipColor attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getTipFontColor

public java.lang.String getTipFontColor()
Gets value of tipFontColor.

Returns:
value of tipFontColor.

isDefaultTipFontColor

public boolean isDefaultTipFontColor()
Checks whether the tipFontColor attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getSelectedColor

public java.lang.String getSelectedColor()
Gets value of selectedColor.

Returns:
value of selectedColor.

isDefaultSelectedColor

public boolean isDefaultSelectedColor()
Checks whether the selectedColor attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getInactiveSelectColor

public java.lang.String getInactiveSelectColor()
Gets value of inactiveSelectColor.

Returns:
value of inactiveSelectColor.

isDefaultInactiveSelectColor

public boolean isDefaultInactiveSelectColor()
Checks whether the inactiveSelectColor attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getSelectedFontColor

public java.lang.String getSelectedFontColor()
Gets value of selectedFontColor.

Returns:
value of selectedFontColor.

isDefaultSelectedFontColor

public boolean isDefaultSelectedFontColor()
Checks whether the selectedFontColor attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getInactiveSelectFontColor

public java.lang.String getInactiveSelectFontColor()
Gets value of inactiveSelectFontColor.

Returns:
value of inactiveSelectFontColor.

isDefaultInactiveSelectFontColor

public boolean isDefaultInactiveSelectFontColor()
Checks whether the inactiveSelectFontColor attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getListOption

public LyListOption getListOption(int i)
Get sub-component ListOption of index i.

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

getListOptionCount

public int getListOptionCount()
Get sub-component ListOption count.

Returns:
sub-component ListOption 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(LyList template)
Initializes attribute template to the given value.

Parameters:
template - New value of template.

setSelectionMode

public void setSelectionMode(LyList.SelectionMode selectionMode)
Initializes attribute selectionMode to the given value.

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

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.

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.

setColor

public void setColor(java.lang.String color)
Initializes attribute color to the given value.

Parameters:
color - New value of color.

setFontColor

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

Parameters:
fontColor - New value of fontColor.

setTipFont

public void setTipFont(java.lang.String tipFont)
Initializes attribute tipFont to the given value.

Parameters:
tipFont - New value of tipFont.

setTipColor

public void setTipColor(java.lang.String tipColor)
Initializes attribute tipColor to the given value.

Parameters:
tipColor - New value of tipColor.

setTipFontColor

public void setTipFontColor(java.lang.String tipFontColor)
Initializes attribute tipFontColor to the given value.

Parameters:
tipFontColor - New value of tipFontColor.

setSelectedColor

public void setSelectedColor(java.lang.String selectedColor)
Initializes attribute selectedColor to the given value.

Parameters:
selectedColor - New value of selectedColor.

setInactiveSelectColor

public void setInactiveSelectColor(java.lang.String inactiveSelectColor)
Initializes attribute inactiveSelectColor to the given value.

Parameters:
inactiveSelectColor - New value of inactiveSelectColor.

setSelectedFontColor

public void setSelectedFontColor(java.lang.String selectedFontColor)
Initializes attribute selectedFontColor to the given value.

Parameters:
selectedFontColor - New value of selectedFontColor.

setInactiveSelectFontColor

public void setInactiveSelectFontColor(java.lang.String inactiveSelectFontColor)
Initializes attribute inactiveSelectFontColor to the given value.

Parameters:
inactiveSelectFontColor - New value of inactiveSelectFontColor.

addListOption

public void addListOption(LyListOption listOption)
Adds a sub-component listOption.

Parameters:
listOption - The listOption to add to listOptions list.

insertListOption

public void insertListOption(LyListOption listOption,
                             int pos)
Inserts a sub-component listOption at given position.

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

removeListOption

public void removeListOption(LyListOption listOption)
Removes a sub-component listOption.

Parameters:
listOption - The listOption to remove to listOptions list.
Throws:
java.lang.IllegalStateException - if listOptions list is empty.
java.lang.IllegalArgumentException - if listOptions list doesn't contain listOption.

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