LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.view
Class LyMessage

java.lang.Object
  extended by leon.view.LyComponent
      extended by leon.view.LyMessage
All Implemented Interfaces:
LyGetControllerInterface, LyGetIdInterface, LyGetLabelInterface, LySetControllerInterface, LySetImageInterface, LySetLabelInterface

public class LyMessage
extends LyComponent
implements LyGetIdInterface, LyGetLabelInterface, LySetLabelInterface, LySetImageInterface, LyGetControllerInterface, LySetControllerInterface

The LyMessage class is a generated Java implementation that corresponds to the element MESSAGE of the descriptive grammar of the views (views.dtd). <MESSAGE> : Message A message is placed inside a message bar. It allows displaying a text and an image.

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

Nested Class Summary
static class LyMessage.Align
          Possible values for attribute 'align'.
 
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
LyMessage(java.lang.String id, java.lang.String label)
          Constructor with all required attributes.
 
Method Summary
 LyComponent cloneComponent()
          Method for cloning a component.
 LyMessage.Align getAlign()
          Gets value of align.
static LyMessage.Align getAlign(java.lang.String token)
          Utility method to get align value from a string.
 java.lang.String getColor()
          Gets value of color.
 java.lang.String getController()
          Gets value of controller.
 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 getImage()
          Gets value of image.
 java.lang.String getLabel()
          Gets value of label.
 int getSize()
          Gets value of size.
 LyMessage 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 isDefaultImage()
          Checks whether the image attribute is valuated to the default value.
 void setAlign(LyMessage.Align align)
          Initializes attribute align to the given value.
 void setColor(java.lang.String color)
          Initializes attribute color to the given value.
 void setController(java.lang.String controller)
          Initializes attribute controller 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 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 setSize(int size)
          Initializes attribute size to the given value.
 void setTemplate(LyMessage 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.LyComponent
addComponent, addData, addEventFunction, clearChildrenBounds, free, freeze, getBounds, getChild, getChildCount, 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

LyMessage

public LyMessage(java.lang.String id,
                 java.lang.String label)
Constructor with all required attributes.

Parameters:
id - Identifier of the message bar.
label - Text of the message.
Method Detail

getAlign

public static final LyMessage.Align getAlign(java.lang.String token)
Utility method to get align value from a string.

Parameters:
token - Token string
Returns:
Align 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 LyMessage 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.

getController

public java.lang.String getController()
Gets value of controller.

Specified by:
getController in interface LyGetControllerInterface
Returns:
value of controller.

getSize

public int getSize()
Gets value of size.

Returns:
value of size.

getAlign

public LyMessage.Align getAlign()
Gets value of align.

Returns:
value of align.

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.

setTemplate

public void setTemplate(LyMessage 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
Parameters:
label - New value of label.
Throws:
java.lang.IllegalArgumentException - if label is null.

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.

setController

public void setController(java.lang.String controller)
Initializes attribute controller to the given value.

Specified by:
setController in interface LySetControllerInterface
Parameters:
controller - New value of controller.
See Also:
LySetControllerInterface.setController(java.lang.String)

setSize

public void setSize(int size)
Initializes attribute size to the given value.

Parameters:
size - New value of size.

setAlign

public void setAlign(LyMessage.Align align)
Initializes attribute align to the given value.

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

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.

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