|
LEONARDI Application Composer - 8.9.0.40 by W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectleon.view.LyComponent
leon.view.LyFieldItem
leon.view.LyPanel
leon.view.LyContainer
leon.view.LyAreaBase
public abstract class LyAreaBase
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.
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 java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String __VERSION
Constructor Detail |
---|
public LyAreaBase()
Method Detail |
---|
public static final LyAreaBase.Scrolling getScrolling(java.lang.String token)
token
- Token string
public static final LyAreaBase.Border getBorder(java.lang.String token)
token
- Token string
public static final LyAreaBase.Layout getLayout(java.lang.String token)
token
- Token string
public LyComponent cloneComponent()
cloneComponent
in class LyComponent
public java.lang.String getId()
getId
in interface LyGetIdInterface
getId
in class LyComponent
public LyArea getTemplate()
public java.lang.String getXmlFile()
public java.lang.String getLabel()
getLabel
in interface LyGetLabelInterface
public java.lang.String getTip()
public java.lang.String getController()
getController
in interface LyGetControllerInterface
public LyAreaBase.Scrolling getScrolling()
public LyAreaBase.Border getBorder()
public int getBorderWidth()
public java.lang.String getRedirect()
public int getRefresh()
getRefresh
in interface LyGetRefreshInterface
public java.lang.String getFont()
public boolean isDefaultFont()
public java.lang.String getColor()
public boolean isDefaultColor()
public java.lang.String getFontColor()
public boolean isDefaultFontColor()
public int getVerticalSpacing()
public int getHorizontalSpacing()
public LyAreaBase.Layout getLayout()
public java.lang.String getLayoutInfo()
public boolean isClosable()
public boolean isOpen()
public LyIcon getIcon()
public LyTitleBar getTitleBar()
public LyToolBar getToolBar(int i)
i
- the index of the ToolBar to get.
public int getToolBarCount()
public LyPanel getPanel(int i)
i
- the index of the Panel to get.
public int getPanelCount()
public LySelectBar getSelectBar()
public LyCommands getCommands()
public LyConstraint getConstraint()
getConstraint
in interface LyGetConstraintInterface
public void setId(java.lang.String id)
id
- New value of id.public void setTemplate(LyArea template)
template
- New value of template.public void setXmlFile(java.lang.String xmlFile)
xmlFile
- New value of xmlFile.public void setLabel(java.lang.String label)
setLabel
in class LyFieldItem
label
- New value of label.public void setTip(java.lang.String tip)
tip
- New value of tip.public void setController(java.lang.String controller)
setController
in interface LySetControllerInterface
controller
- New value of controller.LySetControllerInterface.setController(java.lang.String)
public void setScrolling(LyAreaBase.Scrolling scrolling)
scrolling
- New value of scrolling.
java.lang.IllegalArgumentException
- if scrolling parameter is null.public void setBorder(LyAreaBase.Border border)
border
- New value of border.
java.lang.IllegalArgumentException
- if border parameter is null.public void setBorderWidth(int borderWidth)
borderWidth
- New value of borderWidth.public void setRedirect(java.lang.String redirect)
redirect
- New value of redirect.public void setRefresh(int refresh)
refresh
- New value of refresh.public void setFont(java.lang.String font)
font
- New value of font.public void setColor(java.lang.String color)
color
- New value of color.public void setFontColor(java.lang.String fontColor)
fontColor
- New value of fontColor.public void setVerticalSpacing(int verticalSpacing)
verticalSpacing
- New value of verticalSpacing.public void setHorizontalSpacing(int horizontalSpacing)
horizontalSpacing
- New value of horizontalSpacing.public void setLayout(LyAreaBase.Layout layout)
layout
- New value of layout.
java.lang.IllegalArgumentException
- if layout parameter is null.public void setLayoutInfo(java.lang.String layoutInfo)
layoutInfo
- New value of layoutInfo.public void setClosable(boolean closable)
closable
- Boolean indicating if attribute closable is set or unset.public void setOpen(boolean open)
open
- Boolean indicating if attribute open is set or unset.public void setIcon(LyIcon icon)
icon
- New value of iconpublic void setTitleBar(LyTitleBar titleBar)
titleBar
- New value of titleBarpublic void addToolBar(LyToolBar toolBar)
toolBar
- The toolBar to add to toolBars list.public void insertToolBar(LyToolBar toolBar, int pos)
toolBar
- The toolBar to add to toolBars list.pos
- Position where the sub-component is inserted.public void addPanel(LyPanel panel)
panel
- The panel to add to panels list.public void insertPanel(LyPanel panel, int pos)
panel
- The panel to add to panels list.pos
- Position where the sub-component is inserted.public void removePanel(LyPanel panel)
panel
- The panel to remove to panels list.
java.lang.IllegalStateException
- if panels list is empty.
java.lang.IllegalArgumentException
- if panels list doesn't contain panel.public void setSelectBar(LySelectBar selectBar)
selectBar
- New value of selectBarpublic void setCommands(LyCommands commands)
commands
- New value of commandspublic void setConstraint(LyConstraint constraint)
constraint
- New value of constraintpublic void writeXml(java.io.PrintWriter pw, boolean debug)
writeXml
in class LyComponent
pw
- the printWriter on which the XML is written.debug
- true if debug mode (full dump).
|
(c) January 2013 - W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |