|
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.LyMapBase
public abstract class LyMapBase
The LyMapBase class is a generated Java implementation that corresponds to the element MAP of the descriptive grammar of the views (views.dtd). <MAP> : Map A map allows displaying any type of map view: maps representing geographic or synoptic areas, displaying of elements with different types of positioning, displaying of nodes, links, images, etc. There are four types of elements that can be placed on a map: the nodes, the links, the regions and the images. The elements placed on a map can be sensitive or not (except the images that can never be sensitive). It is possible to specify for the nodes and the links the layer on which they are. This layer allows to place the elements of a higher layer over the elements of a lower layer (for example, the elements of the layer 2 are placed over the elements of the layer 1). The nodes allow defining elements that can be placed at any location on the map and that can be moved. By using a special positioning manager, it is possible to place these nodes according to a predefined geometry (matrix, circle, ellipse, line,...). When zooming on the map, a node keeps always the same aspect unlike an element of image type. The links allow defining segments between two nodes of the map. If one of the two nodes defining the link is moved, the link follows the moved node so that it always starts from its source node and that it always arrives to its destination node. The regions allow representing geometric areas defined by a discrete set of points. These areas can be sensitive. It is notably possible to lead to other map views when launching an action over one of these regions. It is possible to define the background that will be used for the map (defined by an image), the selection mode (none, simple or multiple), the visualization mode (through a viewer or with scroll bars) and to specify if the map is in two or three dimensions. The possible movements on a map are translations, zooms (forward/backward) and rotations. A map in three dimensions allows spatial rotations enabling to display the regions in three dimensions. A map in two dimensions allows the axial rotations around the center of the map.
LyPanel
,
See also tag MAP of grammar leon_views.dtd.
Nested Class Summary | |
---|---|
static class |
LyMapBase.SelectionDraw
Possible values for attribute 'selectionDraw'. |
static class |
LyMapBase.SelectionMode
Possible values for attribute 'selectionMode'. |
static class |
LyMapBase.Style
Possible values for attribute 'style'. |
static class |
LyMapBase.TranslationStatus
Possible values for attribute 'translationStatus'. |
static class |
LyMapBase.ViewerStatus
Possible values for attribute 'viewerStatus'. |
static class |
LyMapBase.ZoomStatus
Possible values for attribute 'zoomStatus'. |
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 | |
---|---|
LyMapBase()
Default constructor. |
Method Summary | |
---|---|
void |
addMapLink(LyMapLink mapLink)
Adds a sub-component mapLink. |
void |
addMapNode(LyMapNode mapNode)
Adds a sub-component mapNode. |
void |
addMapRegion(LyMapRegion mapRegion)
Adds a sub-component mapRegion. |
LyComponent |
cloneComponent()
Method for cloning a component. |
java.lang.String |
getBackground()
Gets value of background. |
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. |
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 |
getLabel()
Gets value of label. |
java.lang.String |
getLatitude()
Gets value of latitude. |
LyLayout |
getLayout()
Get sub-component Layout. |
java.lang.String |
getLongitude()
Gets value of longitude. |
LyMapContent |
getMapContent()
Get sub-component MapContent. |
java.lang.String |
getOutlineColor()
Gets value of outlineColor. |
java.lang.String |
getSelectedColor()
Gets value of selectedColor. |
LyMapBase.SelectionDraw |
getSelectionDraw()
Gets value of selectionDraw. |
static LyMapBase.SelectionDraw |
getSelectionDraw(java.lang.String token)
Utility method to get selectionDraw value from a string. |
LyMapBase.SelectionMode |
getSelectionMode()
Gets value of selectionMode. |
static LyMapBase.SelectionMode |
getSelectionMode(java.lang.String token)
Utility method to get selectionMode value from a string. |
LyMapBase.Style |
getStyle()
Gets value of style. |
static LyMapBase.Style |
getStyle(java.lang.String token)
Utility method to get style value from a string. |
LyMap |
getTemplate()
Gets value of template. |
java.lang.String |
getTitleFont()
Gets value of titleFont. |
LyMapBase.TranslationStatus |
getTranslationStatus()
Gets value of translationStatus. |
static LyMapBase.TranslationStatus |
getTranslationStatus(java.lang.String token)
Utility method to get translationStatus value from a string. |
int |
getTranslationStep()
Gets value of translationStep. |
LyMapBase.ViewerStatus |
getViewerStatus()
Gets value of viewerStatus. |
static LyMapBase.ViewerStatus |
getViewerStatus(java.lang.String token)
Utility method to get viewerStatus value from a string. |
int |
getViewerX()
Gets value of viewerX. |
int |
getViewerY()
Gets value of viewerY. |
int |
getWidth()
Gets value of width. |
float |
getZoomFactor()
Gets value of zoomFactor. |
LyMapBase.ZoomStatus |
getZoomStatus()
Gets value of zoomStatus. |
static LyMapBase.ZoomStatus |
getZoomStatus(java.lang.String token)
Utility method to get zoomStatus value from a string. |
float |
getZoomStep()
Gets value of zoomStep. |
void |
insertMapLink(LyMapLink mapLink,
int pos)
Inserts a sub-component mapLink at given position. |
void |
insertMapNode(LyMapNode mapNode,
int pos)
Inserts a sub-component mapNode at given position. |
void |
insertMapRegion(LyMapRegion mapRegion,
int pos)
Inserts a sub-component mapRegion at given position. |
boolean |
isDefaultColor()
Checks whether the color attribute is valuated to the default value. |
boolean |
isDefaultFontColor()
Checks whether the fontColor attribute is valuated to the default value. |
boolean |
isDefaultOutlineColor()
Checks whether the outlineColor attribute is valuated to the default value. |
boolean |
isDefaultSelectedColor()
Checks whether the selectedColor attribute is valuated to the default value. |
boolean |
isDefaultTitleFont()
Checks whether the titleFont attribute is valuated to the default value. |
boolean |
isSpatial()
Checks if value of attribute spatial is set. |
boolean |
isTranslation()
Checks if value of attribute translation is set. |
boolean |
isViewer()
Checks if value of attribute viewer is set. |
boolean |
isZoom()
Checks if value of attribute zoom is set. |
void |
removeMapLink(LyMapLink mapLink)
Removes a sub-component mapLink. |
void |
removeMapNode(LyMapNode mapNode)
Removes a sub-component mapNode. |
void |
removeMapRegion(LyMapRegion mapRegion)
Removes a sub-component mapRegion. |
void |
setBackground(java.lang.String background)
Initializes attribute background to the given value. |
void |
setColor(java.lang.String color)
Initializes 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 |
setFontColor(java.lang.String fontColor)
Initializes attribute fontColor to the given value. |
void |
setHeight(int height)
Initializes attribute height to the given value. |
void |
setId(java.lang.String id)
Initializes attribute id to the given value. |
void |
setLabel(java.lang.String label)
Sets attribute label to the given value. |
void |
setLatitude(java.lang.String latitude)
Initializes attribute latitude to the given value. |
void |
setLayout(LyLayout layout)
Sets sub-component layout. |
void |
setLongitude(java.lang.String longitude)
Initializes attribute longitude to the given value. |
void |
setMapContent(LyMapContent mapContent)
Sets sub-component mapContent. |
void |
setOutlineColor(java.lang.String outlineColor)
Initializes attribute outlineColor to the given value. |
void |
setSelectedColor(java.lang.String selectedColor)
Initializes attribute selectedColor to the given value. |
void |
setSelectionDraw(LyMapBase.SelectionDraw selectionDraw)
Initializes attribute selectionDraw to the given value. |
void |
setSelectionMode(LyMapBase.SelectionMode selectionMode)
Initializes attribute selectionMode to the given value. |
void |
setSpatial(boolean spatial)
Sets attribute spatial to the given value. |
void |
setStyle(LyMapBase.Style style)
Initializes attribute style to the given value. |
void |
setTemplate(LyMap template)
Initializes attribute template to the given value. |
void |
setTitleFont(java.lang.String titleFont)
Initializes attribute titleFont to the given value. |
void |
setTranslation(boolean translation)
Sets attribute translation to the given value. |
void |
setTranslationStatus(LyMapBase.TranslationStatus translationStatus)
Sets attribute translationStatus to the given value. |
void |
setTranslationStep(int translationStep)
Initializes attribute translationStep to the given value. |
void |
setViewer(boolean viewer)
Sets attribute viewer to the given value. |
void |
setViewerStatus(LyMapBase.ViewerStatus viewerStatus)
Sets attribute viewerStatus to the given value. |
void |
setViewerX(int viewerX)
Initializes attribute viewerX to the given value. |
void |
setViewerY(int viewerY)
Initializes attribute viewerY to the given value. |
void |
setWidth(int width)
Initializes attribute width to the given value. |
void |
setZoom(boolean zoom)
Sets attribute zoom to the given value. |
void |
setZoomFactor(float zoomFactor)
Sets attribute zoomFactor to the given value. |
void |
setZoomStatus(LyMapBase.ZoomStatus zoomStatus)
Sets attribute zoomStatus to the given value. |
void |
setZoomStep(float zoomStep)
Initializes attribute zoomStep 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 LyMapBase()
Method Detail |
---|
public static final LyMapBase.SelectionMode getSelectionMode(java.lang.String token)
token
- Token string
public static final LyMapBase.SelectionDraw getSelectionDraw(java.lang.String token)
token
- Token string
public static final LyMapBase.ViewerStatus getViewerStatus(java.lang.String token)
token
- Token string
public static final LyMapBase.ZoomStatus getZoomStatus(java.lang.String token)
token
- Token string
public static final LyMapBase.TranslationStatus getTranslationStatus(java.lang.String token)
token
- Token string
public static final LyMapBase.Style getStyle(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 LyMap getTemplate()
public java.lang.String getLabel()
getLabel
in interface LyGetLabelInterface
public java.lang.String getController()
getController
in interface LyGetControllerInterface
public LyMapBase.SelectionMode getSelectionMode()
public LyMapBase.SelectionDraw getSelectionDraw()
public boolean isViewer()
public LyMapBase.ViewerStatus getViewerStatus()
public int getViewerX()
public int getViewerY()
public boolean isZoom()
public LyMapBase.ZoomStatus getZoomStatus()
public float getZoomStep()
public float getZoomFactor()
public boolean isTranslation()
public int getTranslationStep()
public LyMapBase.TranslationStatus getTranslationStatus()
public boolean isSpatial()
public java.lang.String getBackground()
public java.lang.String getTitleFont()
public boolean isDefaultTitleFont()
public java.lang.String getColor()
public boolean isDefaultColor()
public java.lang.String getFontColor()
public boolean isDefaultFontColor()
public java.lang.String getSelectedColor()
public boolean isDefaultSelectedColor()
public java.lang.String getOutlineColor()
public boolean isDefaultOutlineColor()
public int getWidth()
public int getHeight()
public LyMapBase.Style getStyle()
public java.lang.String getLatitude()
public java.lang.String getLongitude()
public LyComponent getComponent(int i)
i
- the index of the Component to get.
public int getComponentCount()
public LyMapContent getMapContent()
public LyLayout getLayout()
public LyConstraint getConstraint()
getConstraint
in interface LyGetConstraintInterface
public void setId(java.lang.String id)
id
- New value of id.public void setTemplate(LyMap template)
template
- New value of template.public void setLabel(java.lang.String label)
setLabel
in interface LySetLabelInterface
setLabel
in class LyFieldItem
label
- New value of label.public void setController(java.lang.String controller)
setController
in interface LySetControllerInterface
controller
- New value of controller.LySetControllerInterface.setController(java.lang.String)
public void setSelectionMode(LyMapBase.SelectionMode selectionMode)
selectionMode
- New value of selectionMode.
java.lang.IllegalArgumentException
- if selectionMode parameter is null.public void setSelectionDraw(LyMapBase.SelectionDraw selectionDraw)
selectionDraw
- New value of selectionDraw.
java.lang.IllegalArgumentException
- if selectionDraw parameter is null.public void setViewer(boolean viewer)
setViewer
in interface LySetViewerInterface
viewer
- Boolean indicating if attribute viewer is set or unset.public void setViewerStatus(LyMapBase.ViewerStatus viewerStatus)
viewerStatus
- New value of viewerStatus.
java.lang.IllegalArgumentException
- if viewerStatus parameter is null.public void setViewerX(int viewerX)
viewerX
- New value of viewerX.public void setViewerY(int viewerY)
viewerY
- New value of viewerY.public void setZoom(boolean zoom)
zoom
- Boolean indicating if attribute zoom is set or unset.public void setZoomStatus(LyMapBase.ZoomStatus zoomStatus)
zoomStatus
- New value of zoomStatus.
java.lang.IllegalArgumentException
- if zoomStatus parameter is null.public void setZoomStep(float zoomStep)
zoomStep
- New value of zoomStep.public void setZoomFactor(float zoomFactor)
zoomFactor
- New value of zoomFactor.public void setTranslation(boolean translation)
translation
- Boolean indicating if attribute translation is set or unset.public void setTranslationStep(int translationStep)
translationStep
- New value of translationStep.public void setTranslationStatus(LyMapBase.TranslationStatus translationStatus)
translationStatus
- New value of translationStatus.
java.lang.IllegalArgumentException
- if translationStatus parameter is null.public void setSpatial(boolean spatial)
spatial
- Boolean indicating if attribute spatial is set or unset.public void setBackground(java.lang.String background)
background
- New value of background.public void setTitleFont(java.lang.String titleFont)
titleFont
- New value of titleFont.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 setSelectedColor(java.lang.String selectedColor)
selectedColor
- New value of selectedColor.public void setOutlineColor(java.lang.String outlineColor)
outlineColor
- New value of outlineColor.public void setWidth(int width)
width
- New value of width.public void setHeight(int height)
height
- New value of height.public void setStyle(LyMapBase.Style style)
style
- New value of style.
java.lang.IllegalArgumentException
- if style parameter is null.public void setLatitude(java.lang.String latitude)
latitude
- New value of latitude.public void setLongitude(java.lang.String longitude)
longitude
- New value of longitude.public void addMapNode(LyMapNode mapNode)
mapNode
- The mapNode to add to components list.public void insertMapNode(LyMapNode mapNode, int pos)
mapNode
- The mapNode to add to components list.pos
- Position where the sub-component is inserted.public void removeMapNode(LyMapNode mapNode)
mapNode
- The mapNode to remove to components list.
java.lang.IllegalStateException
- if components list is empty.
java.lang.IllegalArgumentException
- if components list doesn't contain mapNode.public void addMapLink(LyMapLink mapLink)
mapLink
- The mapLink to add to components list.public void insertMapLink(LyMapLink mapLink, int pos)
mapLink
- The mapLink to add to components list.pos
- Position where the sub-component is inserted.public void removeMapLink(LyMapLink mapLink)
mapLink
- The mapLink to remove to components list.
java.lang.IllegalStateException
- if components list is empty.
java.lang.IllegalArgumentException
- if components list doesn't contain mapLink.public void addMapRegion(LyMapRegion mapRegion)
mapRegion
- The mapRegion to add to components list.public void insertMapRegion(LyMapRegion mapRegion, int pos)
mapRegion
- The mapRegion to add to components list.pos
- Position where the sub-component is inserted.public void removeMapRegion(LyMapRegion mapRegion)
mapRegion
- The mapRegion to remove to components list.
java.lang.IllegalStateException
- if components list is empty.
java.lang.IllegalArgumentException
- if components list doesn't contain mapRegion.public void setMapContent(LyMapContent mapContent)
mapContent
- New value of mapContentpublic void setLayout(LyLayout layout)
layout
- New value of layoutpublic 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 |