LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.view
Class LyCommands

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

public class LyCommands
extends LyComponent
implements LyGetIdInterface, LyGetConstraintInterface

The LyCommands class is a generated Java implementation that corresponds to the element COMMANDS of the descriptive grammar of the views (views.dtd). <COMMANDS> : Command Bar A command bar allows displaying a set of command buttons (Validate, Cancel, Close, etc.). This bar is generally located at the bottom of a page or window.

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

Nested Class Summary
static class LyCommands.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
LyCommands()
          Default constructor.
 
Method Summary
 void addCommand(LyCommand command)
          Adds a sub-component command.
 void addSep()
          Adds a separator.
 LyComponent cloneComponent()
          Method for cloning a component.
 LyCommands.Align getAlign()
          Gets value of align.
static LyCommands.Align getAlign(java.lang.String token)
          Utility method to get align value from a string.
 LyAreaBase.Border getBorder()
          Gets value of border.
 java.lang.String getColor()
          Gets value of color.
 LyCommand getCommand(int i)
          Get sub-component Command of index i.
 int getCommandCount()
          Get sub-component Command count.
 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.
 LyCommands getTemplate()
          Gets value of template.
 void insertCommand(LyCommand command, int pos)
          Inserts a sub-component command 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 setAlign(LyCommands.Align align)
          Initializes attribute align to the given value.
 void setBorder(LyAreaBase.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(LyCommands 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

LyCommands

public LyCommands()
Default constructor.

Method Detail

getAlign

public static final LyCommands.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 LyCommands getTemplate()
Gets value of template.

Returns:
value of template.

getBorder

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

Returns:
value of border.

getAlign

public LyCommands.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.

getCommand

public LyCommand getCommand(int i)
Get sub-component Command of index i.

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

getCommandCount

public int getCommandCount()
Get sub-component Command count.

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

Parameters:
template - New value of template.

setBorder

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

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

setAlign

public void setAlign(LyCommands.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.

addCommand

public void addCommand(LyCommand command)
Adds a sub-component command.

Parameters:
command - The command to add to commands list.

insertCommand

public void insertCommand(LyCommand command,
                          int pos)
Inserts a sub-component command at given position.

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

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.

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