LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.view
Class LyAreaBase

java.lang.Object
  extended by leon.view.LyComponent
      extended by leon.view.LyFieldItem
          extended by leon.view.LyPanel
              extended by leon.view.LyContainer
                  extended by leon.view.LyAreaBase
All Implemented Interfaces:
LyGetConstraintInterface, LyGetControllerInterface, LyGetIdInterface, LyGetLabelInterface, LyGetRefreshInterface, LyPdfInterface, LySetControllerInterface, LySetWaitingInterface, LyUpdateViewContentInterface
Direct Known Subclasses:
LyArea

public abstract class LyAreaBase
extends LyContainer
implements LyGetIdInterface, LyGetLabelInterface, LyGetControllerInterface, LySetControllerInterface, LyGetRefreshInterface, LyGetConstraintInterface

The LyAreaBase class is a generated Java implementation that corresponds to the element AREA of the descriptive grammar of the views (views.dtd). <AREA> : Area An area allows the positioning of various graphical components inside a main window or a dialog window. It can contain any type of panel as well as a title bar, a tool bar and a command bar.

See Also:
LyContainer, See also tag AREA of grammar leon_views.dtd.

Nested Class Summary
static class LyAreaBase.Border
          Possible values for attribute 'border'.
static class LyAreaBase.Layout
          Possible values for attribute 'layout'.
static class LyAreaBase.Scrolling
          Possible values for attribute 'scrolling'.
 
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
LyAreaBase()
          Default constructor.
 
Method Summary
 void addPanel(LyPanel panel)
          Adds a sub-component panel.
 void addToolBar(LyToolBar toolBar)
          Adds a sub-component toolBar.
 LyComponent cloneComponent()
          Method for cloning a component.
 LyAreaBase.Border getBorder()
          Gets value of border.
static LyAreaBase.Border getBorder(java.lang.String token)
          Utility method to get border value from a string.
 int getBorderWidth()
          Gets value of borderWidth.
 java.lang.String getColor()
          Gets value of color.
 LyCommands getCommands()
          Get sub-component Commands.
 LyConstraint getConstraint()
          Get sub-component Constraint.
 java.lang.String getController()
          Gets value of controller.
 java.lang.String getFont()
          Gets value of font.
 java.lang.String getFontColor()
          Gets value of fontColor.
 int getHorizontalSpacing()
          Gets value of horizontalSpacing.
 LyIcon getIcon()
          Get sub-component Icon.
 java.lang.String getId()
          Gets value of id.
 java.lang.String getLabel()
          Gets value of label.
 LyAreaBase.Layout getLayout()
          Gets value of layout.
static LyAreaBase.Layout getLayout(java.lang.String token)
          Utility method to get layout value from a string.
 java.lang.String getLayoutInfo()
          Gets value of layoutInfo.
 LyPanel getPanel(int i)
          Get sub-component Panel of index i.
 int getPanelCount()
          Get sub-component Panel count.
 java.lang.String getRedirect()
          Gets value of redirect.
 int getRefresh()
          Gets value of refresh.
 LyAreaBase.Scrolling getScrolling()
          Gets value of scrolling.
static LyAreaBase.Scrolling getScrolling(java.lang.String token)
          Utility method to get scrolling value from a string.
 LySelectBar getSelectBar()
          Get sub-component SelectBar.
 LyArea getTemplate()
          Gets value of template.
 java.lang.String getTip()
          Gets value of tip.
 LyTitleBar getTitleBar()
          Get sub-component TitleBar.
 LyToolBar getToolBar(int i)
          Get sub-component ToolBar of index i.
 int getToolBarCount()
          Get sub-component ToolBar count.
 int getVerticalSpacing()
          Gets value of verticalSpacing.
 java.lang.String getXmlFile()
          Gets value of xmlFile.
 void insertPanel(LyPanel panel, int pos)
          Inserts a sub-component panel at given position.
 void insertToolBar(LyToolBar toolBar, int pos)
          Inserts a sub-component toolBar at given position.
 boolean isClosable()
          Checks if value of attribute closable 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 isOpen()
          Checks if value of attribute open is set.
 void removePanel(LyPanel panel)
          Removes a sub-component panel.
 void setBorder(LyAreaBase.Border border)
          Initializes attribute border to the given value.
 void setBorderWidth(int borderWidth)
          Initializes attribute borderWidth to the given value.
 void setClosable(boolean closable)
          Initializes attribute closable to the given value.
 void setColor(java.lang.String color)
          Initializes attribute color to the given value.
 void setCommands(LyCommands commands)
          Sets sub-component commands.
 void setConstraint(LyConstraint constraint)
          Sets sub-component constraint.
 void setController(java.lang.String controller)
          Initializes attribute controller 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 setHorizontalSpacing(int horizontalSpacing)
          Initializes attribute horizontalSpacing to the given value.
 void setIcon(LyIcon icon)
          Sets sub-component icon.
 void setId(java.lang.String id)
          Initializes attribute id to the given value.
 void setLabel(java.lang.String label)
          Initializes attribute label to the given value.
 void setLayout(LyAreaBase.Layout layout)
          Initializes attribute layout to the given value.
 void setLayoutInfo(java.lang.String layoutInfo)
          Sets attribute layoutInfo to the given value.
 void setOpen(boolean open)
          Sets attribute open to the given value.
 void setRedirect(java.lang.String redirect)
          Sets attribute redirect to the given value.
 void setRefresh(int refresh)
          Sets attribute refresh to the given value.
 void setScrolling(LyAreaBase.Scrolling scrolling)
          Initializes attribute scrolling to the given value.
 void setSelectBar(LySelectBar selectBar)
          Sets sub-component selectBar.
 void setTemplate(LyArea template)
          Initializes attribute template to the given value.
 void setTip(java.lang.String tip)
          Initializes attribute tip to the given value.
 void setTitleBar(LyTitleBar titleBar)
          Sets sub-component titleBar.
 void setVerticalSpacing(int verticalSpacing)
          Initializes attribute verticalSpacing to the given value.
 void setXmlFile(java.lang.String xmlFile)
          Initializes attribute xmlFile 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

LyAreaBase

public LyAreaBase()
Default constructor.

Method Detail

getScrolling

public static final LyAreaBase.Scrolling getScrolling(java.lang.String token)
Utility method to get scrolling value from a string.

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

getBorder

public static final LyAreaBase.Border getBorder(java.lang.String token)
Utility method to get border value from a string.

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

getLayout

public static final LyAreaBase.Layout getLayout(java.lang.String token)
Utility method to get layout value from a string.

Parameters:
token - Token string
Returns:
Layout 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 LyArea getTemplate()
Gets value of template.

Returns:
value of template.

getXmlFile

public java.lang.String getXmlFile()
Gets value of xmlFile.

Returns:
value of xmlFile.

getLabel

public java.lang.String getLabel()
Gets value of label.

Specified by:
getLabel in interface LyGetLabelInterface
Returns:
value of label.

getTip

public java.lang.String getTip()
Gets value of tip.

Returns:
value of tip.

getController

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

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

getScrolling

public LyAreaBase.Scrolling getScrolling()
Gets value of scrolling.

Returns:
value of scrolling.

getBorder

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

Returns:
value of border.

getBorderWidth

public int getBorderWidth()
Gets value of borderWidth.

Returns:
value of borderWidth.

getRedirect

public java.lang.String getRedirect()
Gets value of redirect.

Returns:
value of redirect.

getRefresh

public int getRefresh()
Gets value of refresh.

Specified by:
getRefresh in interface LyGetRefreshInterface
Returns:
value of refresh.

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.

getVerticalSpacing

public int getVerticalSpacing()
Gets value of verticalSpacing.

Returns:
value of verticalSpacing.

getHorizontalSpacing

public int getHorizontalSpacing()
Gets value of horizontalSpacing.

Returns:
value of horizontalSpacing.

getLayout

public LyAreaBase.Layout getLayout()
Gets value of layout.

Returns:
value of layout.

getLayoutInfo

public java.lang.String getLayoutInfo()
Gets value of layoutInfo.

Returns:
value of layoutInfo.

isClosable

public boolean isClosable()
Checks if value of attribute closable is set.

Returns:
true if closable is set, false otherwise.

isOpen

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

Returns:
true if open is set, false otherwise.

getIcon

public LyIcon getIcon()
Get sub-component Icon.

Returns:
sub-component Icon.

getTitleBar

public LyTitleBar getTitleBar()
Get sub-component TitleBar.

Returns:
sub-component TitleBar.

getToolBar

public LyToolBar getToolBar(int i)
Get sub-component ToolBar of index i.

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

getToolBarCount

public int getToolBarCount()
Get sub-component ToolBar count.

Returns:
sub-component ToolBar count.

getPanel

public LyPanel getPanel(int i)
Get sub-component Panel of index i.

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

getPanelCount

public int getPanelCount()
Get sub-component Panel count.

Returns:
sub-component Panel count.

getSelectBar

public LySelectBar getSelectBar()
Get sub-component SelectBar.

Returns:
sub-component SelectBar.

getCommands

public LyCommands getCommands()
Get sub-component Commands.

Returns:
sub-component Commands.

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(LyArea template)
Initializes attribute template to the given value.

Parameters:
template - New value of template.

setXmlFile

public void setXmlFile(java.lang.String xmlFile)
Initializes attribute xmlFile to the given value.

Parameters:
xmlFile - New value of xmlFile.

setLabel

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

Overrides:
setLabel in class LyFieldItem
Parameters:
label - New value of label.

setTip

public void setTip(java.lang.String tip)
Initializes attribute tip to the given value.

Parameters:
tip - New value of tip.

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)

setScrolling

public void setScrolling(LyAreaBase.Scrolling scrolling)
Initializes attribute scrolling to the given value.

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

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.

setBorderWidth

public void setBorderWidth(int borderWidth)
Initializes attribute borderWidth to the given value.

Parameters:
borderWidth - New value of borderWidth.

setRedirect

public void setRedirect(java.lang.String redirect)
Sets attribute redirect to the given value.

Parameters:
redirect - New value of redirect.

setRefresh

public void setRefresh(int refresh)
Sets attribute refresh to the given value.

Parameters:
refresh - New value of refresh.

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.

setVerticalSpacing

public void setVerticalSpacing(int verticalSpacing)
Initializes attribute verticalSpacing to the given value.

Parameters:
verticalSpacing - New value of verticalSpacing.

setHorizontalSpacing

public void setHorizontalSpacing(int horizontalSpacing)
Initializes attribute horizontalSpacing to the given value.

Parameters:
horizontalSpacing - New value of horizontalSpacing.

setLayout

public void setLayout(LyAreaBase.Layout layout)
Initializes attribute layout to the given value.

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

setLayoutInfo

public void setLayoutInfo(java.lang.String layoutInfo)
Sets attribute layoutInfo to the given value.

Parameters:
layoutInfo - New value of layoutInfo.

setClosable

public void setClosable(boolean closable)
Initializes attribute closable to the given value.

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

setOpen

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

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

setIcon

public void setIcon(LyIcon icon)
Sets sub-component icon.

Parameters:
icon - New value of icon

setTitleBar

public void setTitleBar(LyTitleBar titleBar)
Sets sub-component titleBar.

Parameters:
titleBar - New value of titleBar

addToolBar

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

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

insertToolBar

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

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

addPanel

public void addPanel(LyPanel panel)
Adds a sub-component panel.

Parameters:
panel - The panel to add to panels list.

insertPanel

public void insertPanel(LyPanel panel,
                        int pos)
Inserts a sub-component panel at given position.

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

removePanel

public void removePanel(LyPanel panel)
Removes a sub-component panel.

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

setSelectBar

public void setSelectBar(LySelectBar selectBar)
Sets sub-component selectBar.

Parameters:
selectBar - New value of selectBar

setCommands

public void setCommands(LyCommands commands)
Sets sub-component commands.

Parameters:
commands - New value of commands

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