<AREA> : Area

Java class : leon.view.LyArea

ROLE

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.

ATTRIBUTES

<!ATTLIST AREA
	  id NMTOKEN #IMPLIED
	  template NMTOKEN #IMPLIED
	  xmlFile CDATA #IMPLIED
	  label CDATA #IMPLIED
	  tip CDATA #IMPLIED
	  controller CDATA #IMPLIED
	  scrolling ( AUTO | YES | NO) "NO"
	  border ( NONE | IN | OUT | SOLID | RAISED | LOWERED) "NONE"
	  borderWidth NMTOKEN #IMPLIED
	  redirect CDATA #IMPLIED
	  refresh NMTOKEN "0"
	  font CDATA #IMPLIED
	  color CDATA #IMPLIED
	  fontColor CDATA #IMPLIED
	  verticalSpacing NMTOKEN #IMPLIED
	  horizontalSpacing NMTOKEN #IMPLIED
	  layout ( BORDER | CARD | FILL | FLOW | GRID) "GRID"
	  layoutInfo CDATA #IMPLIED
	  closable ( true | false) "false"
	  open ( true | false) "true">
Attribute Mand. Description Default
id no Identifier of the area  
template no Template of the area.  
xmlFile no Path of XML file containing area components.  
label no Title of the area.  
tip no Tip associated to the area.  
controller no Reference of the controller that manages this area (i.e. handles user demands and refresh content).  
scrolling no Indicates if the area should have scroll bars.The following scroll modes are supported:
AUTO The management of the scroll bars is automatic.
If the graphical components contained in the area can managed their own scroll bars, the area let them manage the scroll bars.
YES The area must have scroll bars.
NO The area does not have any scroll bar.
NO
border no Style of the border used for the area. NONE
borderWidth no Border width of the area. -1
redirect no Page to which the area is redirected.
Ressource indicating to which URL the Web browser should be redirected when displaying this area.
 
refresh no Refreshing interval of the area.
Indicates (in seconds) the time after which the area should be updated.
0
font no Font used in this area.  
color no Background color of the component.  
fontColor no Font color of the component.  
verticalSpacing no Vertical spacing of components displayed in the area. -1
horizontalSpacing no Horizontal spacing of components displayed in the area. -1
layout no Layout used in the area.
Supported values are : BORDER, CARD, FILL, FLOW, GRID (default layout).
GRID
layoutInfo no Attribute used to give additional information needed by the layout.  
closable no Indicates whether the area is closable or not. false
open no Indicates whether the area is open or not (only if it is closable). true

ELEMENTS

<!ELEMENT AREA 
	  (ICON?,
	   TITLEBAR?,
	   TOOLBAR*,
	   (%PANEL;)*,
	   SELECTBAR?,
	   COMMANDS?,
	   CONSTRAINT?,
	   DATA*)>
Element Mand. Mult. Description
ICON no no Icon associated to the area.
TITLEBAR no no Title bar of the area.
TOOLBAR no yes Toolbars of the area.
PANEL
no yes Panels contained in the area.
SELECTBAR no no Selection bar of the area.
COMMANDS no no Command bar of the area.
CONSTRAINT no no Positioning constraints in the including area.
DATA no yes AREA.DATA

SAMPLE

<!-- Area containing a title bar and a tool bar -->
<AREA label="MAIN_WINDOW_TITLE">
	<!-- Title bar -->
	...
	<!-- Tool bar -->
	...
</AREA>