LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.view
Class LyToolBarBase

java.lang.Object
  extended by leon.view.LyComponent
      extended by leon.view.LyToolBarBase
All Implemented Interfaces:
LyGetConstraintInterface, LyGetControllerInterface, LyGetIdInterface, LyGetLabelInterface, LySetColorInterface, LySetControllerInterface, LySetImageInterface
Direct Known Subclasses:
LyToolBar

public abstract class LyToolBarBase
extends LyComponent
implements LyGetIdInterface, LyGetLabelInterface, LyGetControllerInterface, LySetControllerInterface, LySetImageInterface, LySetColorInterface, LyGetConstraintInterface

The LyToolBarBase class is a generated Java implementation that corresponds to the element TOOLBAR of the descriptive grammar of the views (views.dtd). <TOOLBAR> : Tool bar A tool bar allows displaying a set of action buttons. A tool bar can itself contain tool bars, which allows grouping together the action buttons into logical groups and sub-groups.

See Also:
LyComponent, See also tag TOOLBAR of grammar leon_views.dtd.

Nested Class Summary
static class LyToolBarBase.Fill
          Possible values for attribute 'fill'.
static class LyToolBarBase.HAlign
          Possible values for attribute 'hAlign'.
static class LyToolBarBase.Style
          Possible values for attribute 'style'.
static class LyToolBarBase.VAlign
          Possible values for attribute 'vAlign'.
 
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
LyToolBarBase()
          Default constructor.
 
Method Summary
 void addFormField(LyFormField formField)
          Adds a sub-component formField.
 void addLabel(LyLabel label)
          Adds a sub-component label.
 void addSep()
          Adds a separator.
 void addTool(LyTool tool)
          Adds a sub-component tool.
 void addToolBar(LyToolBar toolBar)
          Adds a sub-component toolBar.
 LyComponent cloneComponent()
          Method for cloning a component.
 java.lang.String getColor()
          Gets value of color.
 LyComponent getComponent(int i)
          Get sub-component Component of index i.
 int getComponentCount()
          Get sub-component Component count.
 LyConstraint getConstraint()
          Get sub-component Constraint.
 java.lang.String getController()
          Gets value of controller.
 LyToolBarBase.Fill getFill()
          Gets value of fill.
static LyToolBarBase.Fill getFill(java.lang.String token)
          Utility method to get fill value from a string.
 java.lang.String getFont()
          Gets value of font.
 java.lang.String getFontColor()
          Gets value of fontColor.
 LyToolBarBase.HAlign getHAlign()
          Gets value of hAlign.
static LyToolBarBase.HAlign getHAlign(java.lang.String token)
          Utility method to get hAlign value from a string.
 java.lang.String getId()
          Gets value of id.
 java.lang.String getImage()
          Gets value of image.
 java.lang.String getLabel()
          Gets value of label.
 LyToolBarBase.Style getStyle()
          Gets value of style.
static LyToolBarBase.Style getStyle(java.lang.String token)
          Utility method to get style value from a string.
 LyToolBar getTemplate()
          Gets value of template.
 LyToolBarBase.VAlign getVAlign()
          Gets value of vAlign.
static LyToolBarBase.VAlign getVAlign(java.lang.String token)
          Utility method to get vAlign value from a string.
 void insertFormField(LyFormField formField, int pos)
          Inserts a sub-component formField at given position.
 void insertLabel(LyLabel label, int pos)
          Inserts a sub-component label at given position.
 void insertSep(int pos)
          Inserts a separator at the given position.
 void insertTool(LyTool tool, int pos)
          Inserts a sub-component tool at given position.
 void insertToolBar(LyToolBar toolBar, int pos)
          Inserts a sub-component toolBar at 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.
 boolean isDefaultImage()
          Checks whether the image attribute is valuated to the default value.
 boolean isOpen()
          Checks if value of attribute open is set.
 void removeFormField(LyFormField formField)
          Removes a sub-component formField.
 void removeLabel(LyLabel label)
          Removes a sub-component label.
 void removeSep(int pos)
          Removes a separator at the given position.
 void removeTool(LyTool tool)
          Removes a sub-component tool.
 void removeToolBar(LyToolBar toolBar)
          Removes a sub-component toolBar.
 void setColor(java.lang.String color)
          Sets attribute color to the given value.
 void setConstraint(LyConstraint constraint)
          Sets sub-component constraint.
 void setController(java.lang.String controller)
          Initializes attribute controller to the given value.
 void setFill(LyToolBarBase.Fill fill)
          Initializes attribute fill 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 setHAlign(LyToolBarBase.HAlign hAlign)
          Initializes attribute hAlign to the given value.
 void setId(java.lang.String id)
          Initializes attribute id to the given value.
 void setImage(java.lang.String image)
          Sets attribute image to the given value.
 void setLabel(java.lang.String label)
          Initializes attribute label to the given value.
 void setOpen(boolean open)
          Sets attribute open to the given value.
 void setStyle(LyToolBarBase.Style style)
          Initializes attribute style to the given value.
 void setTemplate(LyToolBar template)
          Initializes attribute template to the given value.
 void setVAlign(LyToolBarBase.VAlign vAlign)
          Initializes attribute vAlign 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

LyToolBarBase

public LyToolBarBase()
Default constructor.

Method Detail

getFill

public static final LyToolBarBase.Fill getFill(java.lang.String token)
Utility method to get fill value from a string.

Parameters:
token - Token string
Returns:
Fill value corresponding to this token

getStyle

public static final LyToolBarBase.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

getHAlign

public static final LyToolBarBase.HAlign getHAlign(java.lang.String token)
Utility method to get hAlign value from a string.

Parameters:
token - Token string
Returns:
HAlign value corresponding to this token

getVAlign

public static final LyToolBarBase.VAlign getVAlign(java.lang.String token)
Utility method to get vAlign value from a string.

Parameters:
token - Token string
Returns:
VAlign 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 LyToolBar 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.

getController

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

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

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.

getFill

public LyToolBarBase.Fill getFill()
Gets value of fill.

Returns:
value of fill.

getStyle

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

Returns:
value of style.

getHAlign

public LyToolBarBase.HAlign getHAlign()
Gets value of hAlign.

Returns:
value of hAlign.

getVAlign

public LyToolBarBase.VAlign getVAlign()
Gets value of vAlign.

Returns:
value of vAlign.

isOpen

public boolean isOpen()
Checks if value of attribute open is set.

Returns:
true if open is set, 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.

getComponent

public LyComponent getComponent(int i)
Get sub-component Component of index i.

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

getComponentCount

public int getComponentCount()
Get sub-component Component count.

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

Parameters:
template - New value of template.

setLabel

public void setLabel(java.lang.String label)
Initializes attribute label to the given value.

Parameters:
label - New value of label.

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)

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.

setFill

public void setFill(LyToolBarBase.Fill fill)
Initializes attribute fill to the given value.

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

setStyle

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

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

setHAlign

public void setHAlign(LyToolBarBase.HAlign hAlign)
Initializes attribute hAlign to the given value.

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

setVAlign

public void setVAlign(LyToolBarBase.VAlign vAlign)
Initializes attribute vAlign to the given value.

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

setOpen

public void setOpen(boolean open)
Sets attribute open to the given value.

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

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)
Sets attribute color to the given value.

Specified by:
setColor in interface LySetColorInterface
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.

addTool

public void addTool(LyTool tool)
Adds a sub-component tool.

Parameters:
tool - The tool to add to components list.

insertTool

public void insertTool(LyTool tool,
                       int pos)
Inserts a sub-component tool at given position.

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

removeTool

public void removeTool(LyTool tool)
Removes a sub-component tool.

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

addToolBar

public void addToolBar(LyToolBar toolBar)
Adds a sub-component toolBar.

Parameters:
toolBar - The toolBar to add to components list.

insertToolBar

public void insertToolBar(LyToolBar toolBar,
                          int pos)
Inserts a sub-component toolBar at given position.

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

removeToolBar

public void removeToolBar(LyToolBar toolBar)
Removes a sub-component toolBar.

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

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 components list is empty.
java.lang.IllegalArgumentException - if components list doesn't contain a separator at the given position.

addLabel

public void addLabel(LyLabel label)
Adds a sub-component label.

Parameters:
label - The label to add to components list.

insertLabel

public void insertLabel(LyLabel label,
                        int pos)
Inserts a sub-component label at given position.

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

removeLabel

public void removeLabel(LyLabel label)
Removes a sub-component label.

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

addFormField

public void addFormField(LyFormField formField)
Adds a sub-component formField.

Parameters:
formField - The formField to add to components list.

insertFormField

public void insertFormField(LyFormField formField,
                            int pos)
Inserts a sub-component formField at given position.

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

removeFormField

public void removeFormField(LyFormField formField)
Removes a sub-component formField.

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

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