LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.view
Class LyToolBase

java.lang.Object
  extended by leon.view.LyComponent
      extended by leon.view.LyFieldItem
          extended by leon.view.LyPanel
              extended by leon.view.LyToolBase
All Implemented Interfaces:
LyGetConstraintInterface, LyGetIdInterface, LyGetLabelInterface, LyPdfInterface, LySetEnabledInterface, LySetImageInterface, LySetLabelInterface, LySetWaitingInterface, LyUpdateViewContentInterface
Direct Known Subclasses:
LyTool

public abstract class LyToolBase
extends LyPanel
implements LyGetIdInterface, LyGetLabelInterface, LySetLabelInterface, LySetImageInterface, LySetEnabledInterface, LyGetConstraintInterface

The LyToolBase class is a generated Java implementation that corresponds to the element TOOL of the descriptive grammar of the views (views.dtd). <TOOL> : Action button An action button allows executing an action. In the case where the button contains an area (AREA), this area is displayed in a new window when launching the action.

See Also:
LyPanel, See also tag TOOL of grammar leon_views.dtd.

Nested Class Summary
static class LyToolBase.Style
          Possible values for attribute 'style'.
 
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
LyToolBase(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 getClickColor()
          Gets value of clickColor.
 java.lang.String getColor()
          Gets value of color.
 LyComponent getComponent()
          Get sub-component Component.
 LyConstraint getConstraint()
          Get sub-component Constraint.
 java.lang.String getFont()
          Gets value of font.
 java.lang.String getFontColor()
          Gets value of fontColor.
 int getHeight()
          Gets value of height.
 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 getOverview()
          Gets value of overview.
 LyToolBase.Style getStyle()
          Gets value of style.
static LyToolBase.Style getStyle(java.lang.String token)
          Utility method to get style value from a string.
 LyTool getTemplate()
          Gets value of template.
 java.lang.String getTooltip()
          Gets value of tooltip.
 int getWidth()
          Gets value of width.
 boolean isDefaultClickColor()
          Checks whether the clickColor attribute is valuated to the default value.
 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.
 boolean isPressed()
          Checks if value of attribute pressed is set.
 void setClickColor(java.lang.String clickColor)
          Initializes attribute clickColor to the given value.
 void setColor(java.lang.String color)
          Initializes attribute color to the given value.
 void setComponent(LyComponent component)
          Sets sub-component component.
 void setConstraint(LyConstraint constraint)
          Sets sub-component constraint.
 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 setHeight(int height)
          Initializes attribute height 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 setOverview(java.lang.String overview)
          Initializes attribute overview to the given value.
 void setPressed(boolean pressed)
          Sets attribute pressed to the given value.
 void setStyle(LyToolBase.Style style)
          Initializes attribute style to the given value.
 void setTemplate(LyTool template)
          Initializes attribute template to the given value.
 void setTooltip(java.lang.String tooltip)
          Sets attribute tooltip to the given value.
 void setWidth(int width)
          Initializes attribute width 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

LyToolBase

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

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

getStyle

public static final LyToolBase.Style getStyle(java.lang.String token)
Utility method to get style value from a string.

Parameters:
token - Token string
Returns:
Style 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 LyTool 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.

getTooltip

public java.lang.String getTooltip()
Gets value of tooltip.

Returns:
value of tooltip.

getOverview

public java.lang.String getOverview()
Gets value of overview.

Returns:
value of overview.

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.

getStyle

public LyToolBase.Style getStyle()
Gets value of style.

Returns:
value of style.

isPressed

public boolean isPressed()
Checks if value of attribute pressed is set.

Returns:
true if pressed is set, false otherwise.

isEnabled

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

Returns:
true if enabled is set, false otherwise.

isDialog

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

Returns:
true if dialog is set, false otherwise.

getWidth

public int getWidth()
Gets value of width.

Returns:
value of width.

getHeight

public int getHeight()
Gets value of height.

Returns:
value of height.

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.

getClickColor

public java.lang.String getClickColor()
Gets value of clickColor.

Returns:
value of clickColor.

isDefaultClickColor

public boolean isDefaultClickColor()
Checks whether the clickColor attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getComponent

public LyComponent getComponent()
Get sub-component Component.

Returns:
sub-component Component.

getConstraint

public LyConstraint getConstraint()
Get sub-component Constraint.

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

setTemplate

public void setTemplate(LyTool 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.

setTooltip

public void setTooltip(java.lang.String tooltip)
Sets attribute tooltip to the given value.

Parameters:
tooltip - New value of tooltip.

setOverview

public void setOverview(java.lang.String overview)
Initializes attribute overview to the given value.

Parameters:
overview - New value of overview.

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.

setStyle

public void setStyle(LyToolBase.Style style)
Initializes attribute style to the given value.

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

setPressed

public void setPressed(boolean pressed)
Sets attribute pressed to the given value.

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

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.

setDialog

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

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

setWidth

public void setWidth(int width)
Initializes attribute width to the given value.

Parameters:
width - New value of width.

setHeight

public void setHeight(int height)
Initializes attribute height to the given value.

Parameters:
height - New value of height.

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.

setClickColor

public void setClickColor(java.lang.String clickColor)
Initializes attribute clickColor to the given value.

Parameters:
clickColor - New value of clickColor.

setComponent

public void setComponent(LyComponent component)
Sets sub-component component.

Parameters:
component - New value of component

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