LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.view
Class LyMapRegionBase

java.lang.Object
  extended by leon.view.LyComponent
      extended by leon.view.LyMapRegionBase
All Implemented Interfaces:
LyGetIdInterface, LyGetLabelInterface, LySetHiddenInterface, LySetSelectedInterface
Direct Known Subclasses:
LyMapRegion

public abstract class LyMapRegionBase
extends LyComponent
implements LyGetIdInterface, LyGetLabelInterface, LySetSelectedInterface, LySetHiddenInterface

The LyMapRegionBase class is a generated Java implementation that corresponds to the element MAP_REGION of the descriptive grammar of the views (views.dtd). <MAP_REGION> : Map region A region allows displaying on a map a graphical element made up of a finite set of points. These points define polygons that are displayed on the map with a given color. These elements follow the zooms made on the map (their size increases or decreases when zooming in or out).

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

Nested Class Summary
 
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
LyMapRegionBase()
          Default constructor.
 
Method Summary
 void addMapRegion(LyMapRegion mapRegion)
          Adds a sub-component mapRegion.
 void addPolygon(LyPolygon polygon)
          Adds a sub-component polygon.
 LyComponent cloneComponent()
          Method for cloning a component.
 java.lang.String getBorderColor()
          Gets value of borderColor.
 java.lang.String getColor()
          Gets value of color.
 java.lang.String getFile()
          Gets value of file.
 java.lang.String getFont()
          Gets value of font.
 java.lang.String getFontColor()
          Gets value of fontColor.
 java.lang.String getId()
          Gets value of id.
 java.lang.String getInactiveSelectedColor()
          Gets value of inactiveSelectedColor.
 java.lang.String getLabel()
          Gets value of label.
 int getLayer()
          Gets value of layer.
 LyMapContent getMapContent()
          Get sub-component MapContent.
 LyMapRegion getMapRegion(int i)
          Get sub-component MapRegion of index i.
 int getMapRegionCount()
          Get sub-component MapRegion count.
 java.lang.String getOutlineColor()
          Gets value of outlineColor.
 java.lang.String getOverview()
          Gets value of overview.
 LyPolygon getPolygon(int i)
          Get sub-component Polygon of index i.
 int getPolygonCount()
          Get sub-component Polygon count.
 java.lang.String getSelectedColor()
          Gets value of selectedColor.
 java.lang.String getSmallImage()
          Gets value of smallImage.
 java.lang.String getSmallImageTooltip()
          Gets value of smallImageTooltip.
 LyMapRegion getTemplate()
          Gets value of template.
 java.lang.String getTooltip()
          Gets value of tooltip.
 java.lang.String getTooltipColor()
          Gets value of tooltipColor.
 java.lang.String getTooltipFont()
          Gets value of tooltipFont.
 float getWeight()
          Gets value of weight.
 void insertMapRegion(LyMapRegion mapRegion, int pos)
          Inserts a sub-component mapRegion at given position.
 void insertPolygon(LyPolygon polygon, int pos)
          Inserts a sub-component polygon at given position.
 boolean isBackground()
          Checks if value of attribute background is set.
 boolean isDefaultBorderColor()
          Checks whether the borderColor attribute is valuated to the default value.
 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 isDefaultInactiveSelectedColor()
          Checks whether the inactiveSelectedColor 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 isDefaultSmallImage()
          Checks whether the smallImage attribute is valuated to the default value.
 boolean isDefaultTooltipColor()
          Checks whether the tooltipColor attribute is valuated to the default value.
 boolean isDefaultTooltipFont()
          Checks whether the tooltipFont attribute is valuated to the default value.
 boolean isHidden()
          Checks if value of attribute hidden is set.
 boolean isSelected()
          Checks if value of attribute selected is set.
 boolean isSensitive()
          Checks if value of attribute sensitive is set.
 void removeMapRegion(LyMapRegion mapRegion)
          Removes a sub-component mapRegion.
 void setBackground(boolean background)
          Initializes attribute background to the given value.
 void setBorderColor(java.lang.String borderColor)
          Initializes attribute borderColor to the given value.
 void setColor(java.lang.String color)
          Initializes attribute color to the given value.
 void setFile(java.lang.String file)
          Initializes attribute file 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 setHidden(boolean hidden)
          Sets attribute hidden to the given value.
 void setId(java.lang.String id)
          Initializes attribute id to the given value.
 void setInactiveSelectedColor(java.lang.String inactiveSelectedColor)
          Initializes attribute inactiveSelectedColor to the given value.
 void setLabel(java.lang.String label)
          Initializes attribute label to the given value.
 void setLayer(int layer)
          Initializes attribute layer 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 setOverview(java.lang.String overview)
          Initializes attribute overview to the given value.
 void setSelected(boolean selected)
          Sets attribute selected to the given value.
 void setSelectedColor(java.lang.String selectedColor)
          Initializes attribute selectedColor to the given value.
 void setSensitive(boolean sensitive)
          Initializes attribute sensitive to the given value.
 void setSmallImage(java.lang.String smallImage)
          Sets attribute smallImage to the given value.
 void setSmallImageTooltip(java.lang.String smallImageTooltip)
          Sets attribute smallImageTooltip to the given value.
 void setTemplate(LyMapRegion template)
          Initializes attribute template to the given value.
 void setTooltip(java.lang.String tooltip)
          Initializes attribute tooltip to the given value.
 void setTooltipColor(java.lang.String tooltipColor)
          Initializes attribute tooltipColor to the given value.
 void setTooltipFont(java.lang.String tooltipFont)
          Initializes attribute tooltipFont to the given value.
 void setWeight(float weight)
          Sets attribute weight 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

LyMapRegionBase

public LyMapRegionBase()
Default constructor.

Method Detail

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 LyMapRegion getTemplate()
Gets value of template.

Returns:
value of template.

getFile

public java.lang.String getFile()
Gets value of file.

Returns:
value of file.

getLabel

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

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

getTooltip

public java.lang.String getTooltip()
Gets value of tooltip.

Returns:
value of tooltip.

getSmallImage

public java.lang.String getSmallImage()
Gets value of smallImage.

Returns:
value of smallImage.

isDefaultSmallImage

public boolean isDefaultSmallImage()
Checks whether the smallImage attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getSmallImageTooltip

public java.lang.String getSmallImageTooltip()
Gets value of smallImageTooltip.

Returns:
value of smallImageTooltip.

getWeight

public float getWeight()
Gets value of weight.

Returns:
value of weight.

getOverview

public java.lang.String getOverview()
Gets value of overview.

Returns:
value of overview.

isSensitive

public boolean isSensitive()
Checks if value of attribute sensitive is set.

Returns:
true if sensitive is set, false otherwise.

isSelected

public boolean isSelected()
Checks if value of attribute selected is set.

Returns:
true if selected is set, false otherwise.

isHidden

public boolean isHidden()
Checks if value of attribute hidden is set.

Returns:
true if hidden is set, false otherwise.

isBackground

public boolean isBackground()
Checks if value of attribute background is set.

Returns:
true if background is set, false otherwise.

getLayer

public int getLayer()
Gets value of layer.

Returns:
value of layer.

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.

getBorderColor

public java.lang.String getBorderColor()
Gets value of borderColor.

Returns:
value of borderColor.

isDefaultBorderColor

public boolean isDefaultBorderColor()
Checks whether the borderColor 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.

getTooltipFont

public java.lang.String getTooltipFont()
Gets value of tooltipFont.

Returns:
value of tooltipFont.

isDefaultTooltipFont

public boolean isDefaultTooltipFont()
Checks whether the tooltipFont attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getTooltipColor

public java.lang.String getTooltipColor()
Gets value of tooltipColor.

Returns:
value of tooltipColor.

isDefaultTooltipColor

public boolean isDefaultTooltipColor()
Checks whether the tooltipColor attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getSelectedColor

public java.lang.String getSelectedColor()
Gets value of selectedColor.

Returns:
value of selectedColor.

isDefaultSelectedColor

public boolean isDefaultSelectedColor()
Checks whether the selectedColor attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getInactiveSelectedColor

public java.lang.String getInactiveSelectedColor()
Gets value of inactiveSelectedColor.

Returns:
value of inactiveSelectedColor.

isDefaultInactiveSelectedColor

public boolean isDefaultInactiveSelectedColor()
Checks whether the inactiveSelectedColor attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getOutlineColor

public java.lang.String getOutlineColor()
Gets value of outlineColor.

Returns:
value of outlineColor.

isDefaultOutlineColor

public boolean isDefaultOutlineColor()
Checks whether the outlineColor attribute is valuated to the default value.

Returns:
True if default, false otherwise.

getPolygon

public LyPolygon getPolygon(int i)
Get sub-component Polygon of index i.

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

getPolygonCount

public int getPolygonCount()
Get sub-component Polygon count.

Returns:
sub-component Polygon count.

getMapContent

public LyMapContent getMapContent()
Get sub-component MapContent.

Returns:
sub-component MapContent.

getMapRegion

public LyMapRegion getMapRegion(int i)
Get sub-component MapRegion of index i.

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

getMapRegionCount

public int getMapRegionCount()
Get sub-component MapRegion count.

Returns:
sub-component MapRegion count.

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

Parameters:
template - New value of template.

setFile

public void setFile(java.lang.String file)
Initializes attribute file to the given value.

Parameters:
file - New value of file.

setLabel

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

Parameters:
label - New value of label.

setTooltip

public void setTooltip(java.lang.String tooltip)
Initializes attribute tooltip to the given value.

Parameters:
tooltip - New value of tooltip.

setSmallImage

public void setSmallImage(java.lang.String smallImage)
Sets attribute smallImage to the given value.

Parameters:
smallImage - New value of smallImage.

setSmallImageTooltip

public void setSmallImageTooltip(java.lang.String smallImageTooltip)
Sets attribute smallImageTooltip to the given value.

Parameters:
smallImageTooltip - New value of smallImageTooltip.

setWeight

public void setWeight(float weight)
Sets attribute weight to the given value.

Parameters:
weight - New value of weight.

setOverview

public void setOverview(java.lang.String overview)
Initializes attribute overview to the given value.

Parameters:
overview - New value of overview.

setSensitive

public void setSensitive(boolean sensitive)
Initializes attribute sensitive to the given value.

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

setSelected

public void setSelected(boolean selected)
Sets attribute selected to the given value.

Specified by:
setSelected in interface LySetSelectedInterface
Parameters:
selected - Boolean indicating if attribute selected is set or unset.

setHidden

public void setHidden(boolean hidden)
Sets attribute hidden to the given value.

Specified by:
setHidden in interface LySetHiddenInterface
Parameters:
hidden - Boolean indicating if attribute hidden is set or unset.

setBackground

public void setBackground(boolean background)
Initializes attribute background to the given value.

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

setLayer

public void setLayer(int layer)
Initializes attribute layer to the given value.

Parameters:
layer - New value of layer.

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.

setBorderColor

public void setBorderColor(java.lang.String borderColor)
Initializes attribute borderColor to the given value.

Parameters:
borderColor - New value of borderColor.

setFontColor

public void setFontColor(java.lang.String fontColor)
Initializes attribute fontColor to the given value.

Parameters:
fontColor - New value of fontColor.

setTooltipFont

public void setTooltipFont(java.lang.String tooltipFont)
Initializes attribute tooltipFont to the given value.

Parameters:
tooltipFont - New value of tooltipFont.

setTooltipColor

public void setTooltipColor(java.lang.String tooltipColor)
Initializes attribute tooltipColor to the given value.

Parameters:
tooltipColor - New value of tooltipColor.

setSelectedColor

public void setSelectedColor(java.lang.String selectedColor)
Initializes attribute selectedColor to the given value.

Parameters:
selectedColor - New value of selectedColor.

setInactiveSelectedColor

public void setInactiveSelectedColor(java.lang.String inactiveSelectedColor)
Initializes attribute inactiveSelectedColor to the given value.

Parameters:
inactiveSelectedColor - New value of inactiveSelectedColor.

setOutlineColor

public void setOutlineColor(java.lang.String outlineColor)
Initializes attribute outlineColor to the given value.

Parameters:
outlineColor - New value of outlineColor.

addPolygon

public void addPolygon(LyPolygon polygon)
Adds a sub-component polygon.

Parameters:
polygon - The polygon to add to polygons list.

insertPolygon

public void insertPolygon(LyPolygon polygon,
                          int pos)
Inserts a sub-component polygon at given position.

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

setMapContent

public void setMapContent(LyMapContent mapContent)
Sets sub-component mapContent.

Parameters:
mapContent - New value of mapContent

addMapRegion

public void addMapRegion(LyMapRegion mapRegion)
Adds a sub-component mapRegion.

Parameters:
mapRegion - The mapRegion to add to mapRegions list.

insertMapRegion

public void insertMapRegion(LyMapRegion mapRegion,
                            int pos)
Inserts a sub-component mapRegion at given position.

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

removeMapRegion

public void removeMapRegion(LyMapRegion mapRegion)
Removes a sub-component mapRegion.

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

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