LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.view
Class LyLabel

java.lang.Object
  extended by leon.view.LyComponent
      extended by leon.view.LyFieldItem
          extended by leon.view.LyLabel
All Implemented Interfaces:
LyGetIdInterface, LyGetLabelInterface, LySetFontInterface, LySetImageInterface, LySetLabelInterface, LyUpdateViewContentInterface

public class LyLabel
extends LyFieldItem
implements LyGetIdInterface, LyGetLabelInterface, LySetLabelInterface, LySetImageInterface, LySetFontInterface

The LyLabel class is a generated Java implementation that corresponds to the element LABEL of the descriptive grammar of the views (views.dtd). <LABEL> : Input Field of Label Type An input field of label type allows displaying a simple, non-editable label inside a form. It is used in the consultation forms to show different types of fields (date, number, choice, etc.). It can be made up of one or several lines. It does not comprise any element.

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

Nested Class Summary
static class LyLabel.HAlign
          Possible values for attribute 'hAlign'.
 
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
LyLabel()
          Default constructor.
 
Method Summary
 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.
 LyLabel.HAlign getHAlign()
          Gets value of hAlign.
static LyLabel.HAlign getHAlign(java.lang.String token)
          Utility method to get hAlign value from a string.
 java.lang.String getHighlightColor()
          Gets value of highlightColor.
 java.lang.String getId()
          Gets value of id.
 java.lang.String getImage()
          Gets value of image.
 java.lang.String getLabel()
          Gets value of label.
 int getNCols()
          Gets value of nCols.
 int getNRows()
          Gets value of nRows.
 LyLabel getTemplate()
          Gets value of template.
 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 isDefaultHighlightColor()
          Checks whether the highlightColor attribute is valuated to the default value.
 boolean isDefaultImage()
          Checks whether the image attribute is valuated to the default value.
 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)
          Sets attribute font to the given value.
 void setFontColor(java.lang.String fontColor)
          Initializes attribute fontColor to the given value.
 void setHAlign(LyLabel.HAlign hAlign)
          Initializes attribute hAlign to the given value.
 void setHighlightColor(java.lang.String highlightColor)
          Initializes attribute highlightColor to the given value.
 void setId(java.lang.String id)
          Initializes attribute id to the given value.
 void setImage(java.lang.String image)
          Sets attribute image to the given value.
 void setLabel(java.lang.String label)
          Sets attribute label 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 setTemplate(LyLabel template)
          Initializes attribute template 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

LyLabel

public LyLabel()
Default constructor.

Method Detail

getHAlign

public static final LyLabel.HAlign getHAlign(java.lang.String token)
Utility method to get hAlign value from a string.

Parameters:
token - Token string
Returns:
HAlign 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 LyLabel 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.

getImage

public java.lang.String getImage()
Gets value of image.

Returns:
value of image.

isDefaultImage

public boolean isDefaultImage()
Checks whether the image attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getHAlign

public LyLabel.HAlign getHAlign()
Gets value of hAlign.

Returns:
value of hAlign.

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.

getHighlightColor

public java.lang.String getHighlightColor()
Gets value of highlightColor.

Returns:
value of highlightColor.

isDefaultHighlightColor

public boolean isDefaultHighlightColor()
Checks whether the highlightColor attribute is valuated to the default value.

Returns:
True if default, 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.

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(LyLabel 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.

setImage

public void setImage(java.lang.String image)
Sets attribute image to the given value.

Specified by:
setImage in interface LySetImageInterface
Parameters:
image - New value of image.

setHAlign

public void setHAlign(LyLabel.HAlign hAlign)
Initializes attribute hAlign to the given value.

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

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)
Sets attribute font to the given value.

Specified by:
setFont in interface LySetFontInterface
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.

setHighlightColor

public void setHighlightColor(java.lang.String highlightColor)
Initializes attribute highlightColor to the given value.

Parameters:
highlightColor - New value of highlightColor.

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.

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