LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.view
Class LyMapLink

java.lang.Object
  extended by leon.view.LyComponent
      extended by leon.view.LyMapLink
All Implemented Interfaces:
LyGetIdInterface, LyGetLabelInterface, LySetHiddenInterface, LySetLabelInterface, LySetSelectedInterface

public class LyMapLink
extends LyComponent
implements LyGetIdInterface, LyGetLabelInterface, LySetLabelInterface, LySetSelectedInterface, LySetHiddenInterface

The LyMapLink class is a generated Java implementation that corresponds to the element MAP_LINK of the descriptive grammar of the views (views.dtd). <MAP_LINK> : Map link This element represents a link between two nodes in a map.

See Also:
See also tag MAP_LINK of grammar leon_views.dtd.

Nested Class Summary
static class LyMapLink.Arrow
          Possible values for attribute 'arrow'.
static class LyMapLink.ArrowFill
          Possible values for attribute 'startArrowFillMode'.
static class LyMapLink.ArrowType
          Possible values for attribute 'startArrowType'.
static class LyMapLink.Style
          Possible values for attribute 'style'.
 
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
LyMapLink(java.lang.String startNode, java.lang.String endNode)
          Constructor with all required attributes.
 
Method Summary
 void addPoint(LyPoint point)
          Adds a sub-component point.
 LyComponent cloneComponent()
          Method for cloning a component.
 LyMapLink.Arrow getArrow()
          Gets value of arrow.
static LyMapLink.Arrow getArrow(java.lang.String token)
          Utility method to get arrow value from a string.
static LyMapLink.ArrowFill getArrowFill(java.lang.String token)
          Utility method to get startArrowFillMode value from a string.
static LyMapLink.ArrowType getArrowType(java.lang.String token)
          Utility method to get startArrowType value from a string.
 java.lang.String getColor()
          Gets value of color.
 java.lang.String getColorEnd()
          Gets value of colorEnd.
 java.lang.String getColorStart()
          Gets value of colorStart.
 LyMapLink.ArrowFill getEndArrowFillMode()
          Gets value of endArrowFillMode.
 LyMapLink.ArrowType getEndArrowType()
          Gets value of endArrowType.
 java.lang.String getEndLabel()
          Gets value of endLabel.
 java.lang.String getEndNode()
          Gets value of endNode.
 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 getImageEnd()
          Gets value of imageEnd.
 java.lang.String getImageMiddle()
          Gets value of imageMiddle.
 java.lang.String getImageStart()
          Gets value of imageStart.
 java.lang.String getInactiveSelectedColor()
          Gets value of inactiveSelectedColor.
 java.lang.String getLabel()
          Gets value of label.
 int getLayer()
          Gets value of layer.
 java.lang.String getMotif()
          Gets value of motif.
 java.lang.String getOutlineColor()
          Gets value of outlineColor.
 java.lang.String getOverview()
          Gets value of overview.
 LyPoint getPoint(int i)
          Get sub-component Point of index i.
 int getPointCount()
          Get sub-component Point count.
 java.lang.String getSelectedColor()
          Gets value of selectedColor.
 LyMapLink.ArrowFill getStartArrowFillMode()
          Gets value of startArrowFillMode.
 LyMapLink.ArrowType getStartArrowType()
          Gets value of startArrowType.
 java.lang.String getStartLabel()
          Gets value of startLabel.
 java.lang.String getStartNode()
          Gets value of startNode.
 LyMapLink.Style getStyle()
          Gets value of style.
static LyMapLink.Style getStyle(java.lang.String token)
          Utility method to get style value from a string.
 LyMapLink getTemplate()
          Gets value of template.
 java.lang.String getTooltip()
          Gets value of tooltip.
 int getWidth()
          Gets value of width.
 void insertPoint(LyPoint point, int pos)
          Inserts a sub-component point at given position.
 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 isDoubleLink()
          Checks if value of attribute doubleLink is set.
 boolean isHidden()
          Checks if value of attribute hidden is set.
 boolean isImageEndBlink()
          Checks if value of attribute imageEndBlink is set.
 boolean isImageMiddleBlink()
          Checks if value of attribute imageMiddleBlink is set.
 boolean isImageStartBlink()
          Checks if value of attribute imageStartBlink is set.
 boolean isSelected()
          Checks if value of attribute selected is set.
 boolean isSensitive()
          Checks if value of attribute sensitive is set.
 void removePoint(LyPoint point)
          Removes a sub-component point.
 void setArrow(LyMapLink.Arrow arrow)
          Initializes attribute arrow to the given value.
 void setColor(java.lang.String color)
          Initializes attribute color to the given value.
 void setColorEnd(java.lang.String colorEnd)
          Sets attribute colorEnd to the given value.
 void setColorStart(java.lang.String colorStart)
          Sets attribute colorStart to the given value.
 void setDoubleLink(boolean doubleLink)
          Initializes attribute doubleLink to the given value.
 void setEndArrowFillMode(LyMapLink.ArrowFill endArrowFillMode)
          Initializes attribute endArrowFillMode to the given value.
 void setEndArrowType(LyMapLink.ArrowType endArrowType)
          Initializes attribute endArrowType to the given value.
 void setEndLabel(java.lang.String endLabel)
          Sets attribute endLabel to the given value.
 void setEndNode(java.lang.String endNode)
          Initializes attribute endNode 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 setImageEnd(java.lang.String imageEnd)
          Initializes attribute imageEnd to the given value.
 void setImageEndBlink(boolean imageEndBlink)
          Initializes attribute imageEndBlink to the given value.
 void setImageMiddle(java.lang.String imageMiddle)
          Initializes attribute imageMiddle to the given value.
 void setImageMiddleBlink(boolean imageMiddleBlink)
          Initializes attribute imageMiddleBlink to the given value.
 void setImageStart(java.lang.String imageStart)
          Initializes attribute imageStart to the given value.
 void setImageStartBlink(boolean imageStartBlink)
          Initializes attribute imageStartBlink to the given value.
 void setInactiveSelectedColor(java.lang.String inactiveSelectedColor)
          Initializes attribute inactiveSelectedColor to the given value.
 void setLabel(java.lang.String label)
          Sets attribute label to the given value.
 void setLayer(int layer)
          Initializes attribute layer to the given value.
 void setMotif(java.lang.String motif)
          Initializes attribute motif to the given value.
 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 setStartArrowFillMode(LyMapLink.ArrowFill startArrowFillMode)
          Initializes attribute startArrowFillMode to the given value.
 void setStartArrowType(LyMapLink.ArrowType startArrowType)
          Initializes attribute startArrowType to the given value.
 void setStartLabel(java.lang.String startLabel)
          Sets attribute startLabel to the given value.
 void setStartNode(java.lang.String startNode)
          Initializes attribute startNode to the given value.
 void setStyle(LyMapLink.Style style)
          Initializes attribute style to the given value.
 void setTemplate(LyMapLink template)
          Initializes attribute template to the given value.
 void setTooltip(java.lang.String tooltip)
          Initializes attribute tooltip to the given value.
 void setWidth(int width)
          Initializes attribute width 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

LyMapLink

public LyMapLink(java.lang.String startNode,
                 java.lang.String endNode)
Constructor with all required attributes.

Parameters:
startNode - Start node of the link.
A link has always a start and a destination node.
The expected value is the identifier of a node of the map.
endNode - Destination node of the link.
The expected value is the identifier of a node.
Method Detail

getStyle

public static final LyMapLink.Style getStyle(java.lang.String token)
Utility method to get style value from a string.

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

getArrow

public static final LyMapLink.Arrow getArrow(java.lang.String token)
Utility method to get arrow value from a string.

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

getArrowType

public static final LyMapLink.ArrowType getArrowType(java.lang.String token)
Utility method to get startArrowType value from a string.

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

getArrowFill

public static final LyMapLink.ArrowFill getArrowFill(java.lang.String token)
Utility method to get startArrowFillMode value from a string.

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

Returns:
value of template.

getLabel

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

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

getStartLabel

public java.lang.String getStartLabel()
Gets value of startLabel.

Returns:
value of startLabel.

getEndLabel

public java.lang.String getEndLabel()
Gets value of endLabel.

Returns:
value of endLabel.

getTooltip

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

Returns:
value of tooltip.

getOverview

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

Returns:
value of overview.

getStartNode

public java.lang.String getStartNode()
Gets value of startNode.

Returns:
value of startNode.

getEndNode

public java.lang.String getEndNode()
Gets value of endNode.

Returns:
value of endNode.

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.

isDoubleLink

public boolean isDoubleLink()
Checks if value of attribute doubleLink is set.

Returns:
true if doubleLink is set, false otherwise.

getWidth

public int getWidth()
Gets value of width.

Returns:
value of width.

getStyle

public LyMapLink.Style getStyle()
Gets value of style.

Returns:
value of style.

getArrow

public LyMapLink.Arrow getArrow()
Gets value of arrow.

Returns:
value of arrow.

getStartArrowType

public LyMapLink.ArrowType getStartArrowType()
Gets value of startArrowType.

Returns:
value of startArrowType.

getStartArrowFillMode

public LyMapLink.ArrowFill getStartArrowFillMode()
Gets value of startArrowFillMode.

Returns:
value of startArrowFillMode.

getEndArrowType

public LyMapLink.ArrowType getEndArrowType()
Gets value of endArrowType.

Returns:
value of endArrowType.

getEndArrowFillMode

public LyMapLink.ArrowFill getEndArrowFillMode()
Gets value of endArrowFillMode.

Returns:
value of endArrowFillMode.

getMotif

public java.lang.String getMotif()
Gets value of motif.

Returns:
value of motif.

getImageStart

public java.lang.String getImageStart()
Gets value of imageStart.

Returns:
value of imageStart.

getImageMiddle

public java.lang.String getImageMiddle()
Gets value of imageMiddle.

Returns:
value of imageMiddle.

getImageEnd

public java.lang.String getImageEnd()
Gets value of imageEnd.

Returns:
value of imageEnd.

getColorStart

public java.lang.String getColorStart()
Gets value of colorStart.

Returns:
value of colorStart.

getColorEnd

public java.lang.String getColorEnd()
Gets value of colorEnd.

Returns:
value of colorEnd.

getLayer

public int getLayer()
Gets value of layer.

Returns:
value of layer.

isHidden

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

Returns:
true if hidden is set, false otherwise.

isImageStartBlink

public boolean isImageStartBlink()
Checks if value of attribute imageStartBlink is set.

Returns:
true if imageStartBlink is set, false otherwise.

isImageMiddleBlink

public boolean isImageMiddleBlink()
Checks if value of attribute imageMiddleBlink is set.

Returns:
true if imageMiddleBlink is set, false otherwise.

isImageEndBlink

public boolean isImageEndBlink()
Checks if value of attribute imageEndBlink is set.

Returns:
true if imageEndBlink is set, false otherwise.

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.

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.

getPoint

public LyPoint getPoint(int i)
Get sub-component Point of index i.

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

getPointCount

public int getPointCount()
Get sub-component Point count.

Returns:
sub-component Point 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(LyMapLink template)
Initializes attribute template to the given value.

Parameters:
template - New value of template.

setLabel

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

Specified by:
setLabel in interface LySetLabelInterface
Parameters:
label - New value of label.

setStartLabel

public void setStartLabel(java.lang.String startLabel)
Sets attribute startLabel to the given value.

Parameters:
startLabel - New value of startLabel.

setEndLabel

public void setEndLabel(java.lang.String endLabel)
Sets attribute endLabel to the given value.

Parameters:
endLabel - New value of endLabel.

setTooltip

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

Parameters:
tooltip - New value of tooltip.

setOverview

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

Parameters:
overview - New value of overview.

setStartNode

public void setStartNode(java.lang.String startNode)
Initializes attribute startNode to the given value.

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

setEndNode

public void setEndNode(java.lang.String endNode)
Initializes attribute endNode to the given value.

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

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.

setDoubleLink

public void setDoubleLink(boolean doubleLink)
Initializes attribute doubleLink to the given value.

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

setWidth

public void setWidth(int width)
Initializes attribute width to the given value.

Parameters:
width - New value of width.

setStyle

public void setStyle(LyMapLink.Style style)
Initializes attribute style to the given value.

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

setArrow

public void setArrow(LyMapLink.Arrow arrow)
Initializes attribute arrow to the given value.

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

setStartArrowType

public void setStartArrowType(LyMapLink.ArrowType startArrowType)
Initializes attribute startArrowType to the given value.

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

setStartArrowFillMode

public void setStartArrowFillMode(LyMapLink.ArrowFill startArrowFillMode)
Initializes attribute startArrowFillMode to the given value.

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

setEndArrowType

public void setEndArrowType(LyMapLink.ArrowType endArrowType)
Initializes attribute endArrowType to the given value.

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

setEndArrowFillMode

public void setEndArrowFillMode(LyMapLink.ArrowFill endArrowFillMode)
Initializes attribute endArrowFillMode to the given value.

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

setMotif

public void setMotif(java.lang.String motif)
Initializes attribute motif to the given value.

Parameters:
motif - New value of motif.

setImageStart

public void setImageStart(java.lang.String imageStart)
Initializes attribute imageStart to the given value.

Parameters:
imageStart - New value of imageStart.

setImageMiddle

public void setImageMiddle(java.lang.String imageMiddle)
Initializes attribute imageMiddle to the given value.

Parameters:
imageMiddle - New value of imageMiddle.

setImageEnd

public void setImageEnd(java.lang.String imageEnd)
Initializes attribute imageEnd to the given value.

Parameters:
imageEnd - New value of imageEnd.

setColorStart

public void setColorStart(java.lang.String colorStart)
Sets attribute colorStart to the given value.

Parameters:
colorStart - New value of colorStart.

setColorEnd

public void setColorEnd(java.lang.String colorEnd)
Sets attribute colorEnd to the given value.

Parameters:
colorEnd - New value of colorEnd.

setLayer

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

Parameters:
layer - New value of layer.

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.

setImageStartBlink

public void setImageStartBlink(boolean imageStartBlink)
Initializes attribute imageStartBlink to the given value.

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

setImageMiddleBlink

public void setImageMiddleBlink(boolean imageMiddleBlink)
Initializes attribute imageMiddleBlink to the given value.

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

setImageEndBlink

public void setImageEndBlink(boolean imageEndBlink)
Initializes attribute imageEndBlink to the given value.

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

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.

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.

addPoint

public void addPoint(LyPoint point)
Adds a sub-component point.

Parameters:
point - The point to add to points list.

insertPoint

public void insertPoint(LyPoint point,
                        int pos)
Inserts a sub-component point at given position.

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

removePoint

public void removePoint(LyPoint point)
Removes a sub-component point.

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

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