LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.view
Class LyCommand

java.lang.Object
  extended by leon.view.LyComponent
      extended by leon.view.LyFieldItem
          extended by leon.view.LyPanel
              extended by leon.view.LyCommand
All Implemented Interfaces:
LyGetConstraintInterface, LyGetIdInterface, LyGetLabelInterface, LyPdfInterface, LySetEnabledInterface, LySetLabelInterface, LySetWaitingInterface, LyUpdateViewContentInterface

public class LyCommand
extends LyPanel
implements LyGetIdInterface, LyGetLabelInterface, LySetLabelInterface, LySetEnabledInterface, LyGetConstraintInterface

The LyCommand class is a generated Java implementation that corresponds to the element COMMAND of the descriptive grammar of the views (views.dtd). <COMMAND> : Command Button A command button allows executing an action. There are predefined types of command giving information about the nature of the action to execute (closing, cancellation, help, etc.).

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

Nested Class Summary
static class LyCommand.Action
          Possible values for attribute 'action'.
 
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
LyCommand(java.lang.String id, java.lang.String label)
          Constructor with all required attributes.
 
Method Summary
 LyComponent cloneComponent()
          Method for cloning a component.
 LyCommand.Action getAction()
          Gets value of action.
static LyCommand.Action getAction(java.lang.String token)
          Utility method to get action 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.
 java.lang.String getImage()
          Gets value of image.
 java.lang.String getLabel()
          Gets value of label.
 LyCommand 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 isEnabled()
          Checks if value of attribute enabled is set.
 void setAction(LyCommand.Action action)
          Initializes attribute action 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 setEnabled(boolean enabled)
          Sets attribute enabled 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)
          Initializes attribute image to the given value.
 void setLabel(java.lang.String label)
          Sets attribute label to the given value.
 void setTemplate(LyCommand 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.LyPanel
generatePdf, getLastModified, isIdle, isScrollable, print, setIdle, setLastModified, setPopupMenu, setWaiting
 
Methods inherited from class leon.view.LyFieldItem
addBeanData, buildBean, free, getBean, getBeanComponent, getBeanData, getBeanDatas, getChild, getChildCount, getErrorMessage, getFieldValue, getValue, setBean, 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

LyCommand

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

Parameters:
id - Identifier of the command button.
label - Text of the command button.
Method Detail

getAction

public static final LyCommand.Action getAction(java.lang.String token)
Utility method to get action value from a string.

Parameters:
token - Token string
Returns:
Action 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 LyCommand 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.

isEnabled

public boolean isEnabled()
Checks if value of attribute enabled is set.

Returns:
true if enabled is set, false otherwise.

getAction

public LyCommand.Action getAction()
Gets value of action.

Returns:
value of action.

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.

getConstraint

public LyConstraint getConstraint()
Get sub-component Constraint.

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

setTemplate

public void setTemplate(LyCommand 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.
Throws:
java.lang.IllegalArgumentException - if label is null.

setImage

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

Parameters:
image - New value of image.

setEnabled

public void setEnabled(boolean enabled)
Sets attribute enabled to the given value.

Specified by:
setEnabled in interface LySetEnabledInterface
Parameters:
enabled - Boolean indicating if attribute enabled is set or unset.

setAction

public void setAction(LyCommand.Action action)
Initializes attribute action to the given value.

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

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