LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.view
Class LyItem

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

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

The LyItem class is a generated Java implementation that corresponds to the element ITEM of the descriptive grammar of the views (views.dtd). <ITEM> : Menu entry A menu entry allows executing an action, as when using an action button. The entry can be of check box type (checkbox attribute) and can open a dialog window (dialog attribute).

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

Nested Class Summary
 
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
LyItem(java.lang.String id, java.lang.String label)
          Constructor with all required attributes.
 
Method Summary
 LyComponent cloneComponent()
          Method for cloning a component.
 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.
 java.lang.String getShortcut()
          Gets value of shortcut.
 LyItem getTemplate()
          Gets value of template.
 boolean isCheckBox()
          Checks if value of attribute checkBox is set.
 boolean isChecked()
          Checks if value of attribute checked is set.
 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.
 boolean isDialog()
          Checks if value of attribute dialog is set.
 boolean isEnabled()
          Checks if value of attribute enabled is set.
 void setCheckBox(boolean checkBox)
          Initializes attribute checkBox to the given value.
 void setChecked(boolean checked)
          Sets attribute checked 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 setDialog(boolean dialog)
          Initializes attribute dialog to the given value.
 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)
          Sets attribute image to the given value.
 void setLabel(java.lang.String label)
          Sets attribute label to the given value.
 void setShortcut(java.lang.String shortcut)
          Initializes attribute shortcut to the given value.
 void setTemplate(LyItem 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

LyItem

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

Parameters:
id - Identifier of the menu entry.
label - Text of the menu entry.
Method Detail

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 LyItem 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.

getShortcut

public java.lang.String getShortcut()
Gets value of shortcut.

Returns:
value of shortcut.

getController

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

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

isEnabled

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

Returns:
true if enabled is set, false otherwise.

isCheckBox

public boolean isCheckBox()
Checks if value of attribute checkBox is set.

Returns:
true if checkBox is set, false otherwise.

isChecked

public boolean isChecked()
Checks if value of attribute checked is set.

Returns:
true if checked is set, false otherwise.

isDialog

public boolean isDialog()
Checks if value of attribute dialog is set.

Returns:
true if dialog is set, false otherwise.

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.

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

setShortcut

public void setShortcut(java.lang.String shortcut)
Initializes attribute shortcut to the given value.

Parameters:
shortcut - New value of shortcut.

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)

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.

setCheckBox

public void setCheckBox(boolean checkBox)
Initializes attribute checkBox to the given value.

Parameters:
checkBox - Boolean indicating if attribute checkBox is set or unset.

setChecked

public void setChecked(boolean checked)
Sets attribute checked to the given value.

Parameters:
checked - Boolean indicating if attribute checked is set or unset.

setDialog

public void setDialog(boolean dialog)
Initializes attribute dialog to the given value.

Parameters:
dialog - Boolean indicating if attribute dialog is set or unset.

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.

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