LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.view
Class LyMessages

java.lang.Object
  extended by leon.view.LyComponent
      extended by leon.view.LyMessages
All Implemented Interfaces:
LyGetConstraintInterface, LyGetIdInterface

public class LyMessages
extends LyComponent
implements LyGetIdInterface, LyGetConstraintInterface

The LyMessages class is a generated Java implementation that corresponds to the element MESSAGES of the descriptive grammar of the views (views.dtd). <MESSAGES> : Message bar A message bar can be used in a main window to provide the user with information about the displayed data (number of objects, printing in progress...).

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

Nested Class Summary
static class LyMessages.Border
          Possible values for attribute 'border'.
 
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
LyMessages()
          Default constructor.
 
Method Summary
 void addMessage(LyMessage message)
          Adds a sub-component message.
 void addSep()
          Adds a separator.
 LyComponent cloneComponent()
          Method for cloning a component.
 LyMessages.Border getBorder()
          Gets value of border.
static LyMessages.Border getBorder(java.lang.String token)
          Utility method to get border value from a string.
 java.lang.String getColor()
          Gets value of color.
 LyConstraint getConstraint()
          Get sub-component Constraint.
 java.lang.String getFont()
          Gets value of font.
 java.lang.String getFontColor()
          Gets value of fontColor.
 java.lang.String getId()
          Gets value of id.
 LyMessage getMessage(int i)
          Get sub-component Message of index i.
 int getMessageCount()
          Get sub-component Message count.
 LyMessages getTemplate()
          Gets value of template.
 void insertMessage(LyMessage message, int pos)
          Inserts a sub-component message at given position.
 void insertSep(int pos)
          Inserts a separator at the 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.
 void removeMessage(LyMessage message)
          Removes a sub-component message.
 void removeSep(int pos)
          Removes a separator at the given position.
 void setBorder(LyMessages.Border border)
          Initializes attribute border to the given value.
 void setColor(java.lang.String color)
          Initializes attribute color to the given value.
 void setConstraint(LyConstraint constraint)
          Sets sub-component constraint.
 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 setTemplate(LyMessages 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

LyMessages

public LyMessages()
Default constructor.

Method Detail

getBorder

public static final LyMessages.Border getBorder(java.lang.String token)
Utility method to get border value from a string.

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

Returns:
value of template.

getBorder

public LyMessages.Border getBorder()
Gets value of border.

Returns:
value of border.

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.

getMessage

public LyMessage getMessage(int i)
Get sub-component Message of index i.

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

getMessageCount

public int getMessageCount()
Get sub-component Message count.

Returns:
sub-component Message count.

getConstraint

public LyConstraint getConstraint()
Get sub-component Constraint.

Specified by:
getConstraint in interface LyGetConstraintInterface
Returns:
sub-component Constraint.

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(LyMessages template)
Initializes attribute template to the given value.

Parameters:
template - New value of template.

setBorder

public void setBorder(LyMessages.Border border)
Initializes attribute border to the given value.

Parameters:
border - New value of border.
Throws:
java.lang.IllegalArgumentException - if border 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.

addMessage

public void addMessage(LyMessage message)
Adds a sub-component message.

Parameters:
message - The message to add to messages list.

insertMessage

public void insertMessage(LyMessage message,
                          int pos)
Inserts a sub-component message at given position.

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

removeMessage

public void removeMessage(LyMessage message)
Removes a sub-component message.

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

addSep

public void addSep()
Adds a separator.


insertSep

public void insertSep(int pos)
Inserts a separator at the given position.

Parameters:
pos - Position where the separator is inserted.

removeSep

public void removeSep(int pos)
Removes a separator at the given position.

Parameters:
pos - Position where the separator is removed.
Throws:
java.lang.IllegalStateException - if messages list is empty.
java.lang.IllegalArgumentException - if messages list doesn't contain a separator at the given position.

setConstraint

public void setConstraint(LyConstraint constraint)
Sets sub-component constraint.

Parameters:
constraint - New value of constraint

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