IDiagramNode (Modelio 5.3 API (commercial))

All Superinterfaces:

IDiagramGraphic

All Known Subinterfaces:

IDiagramDG, IDiagramDrawingNode
```
public interface IDiagramNode
extends IDiagramGraphic
```
This class represents a DiagramGraphic of the 'node' kind.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class IDiagramNode.Role
Role of a node within its parent node.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`IDiagramNode.Role` Role of a node within its `parent node`.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`fitToContent()` Resize this diagram node to fit its content.
`Rectangle`	`getBounds()` Return the node location and size as a Rectangle.
`MObject`	`getElement()` Get the element this `IDiagramGraphic` is related to.
`java.lang.String`	`getFillColor()` Get the current fill color.
`int`	`getFillMode()` Get the current fill mode.
`IDiagramNode`	`getFirstNode(IDiagramNode.Role role)` Get the first child node with the given role.
`java.lang.String`	`getFont()` Get the current font, represented by font data.
`java.lang.String`	`getLineColor()` Get the current line color.
`int`	`getLineWidth()` Get the current line width.
`java.util.List<IDiagramNode>`	`getNodes()` Return the list of children nodes of this node.
`java.util.Collection<IDiagramNode>`	`getNodes(IDiagramNode.Role role)` Get the child nodes with the given role.
`Rectangle`	`getOverallBounds()` Return the location and size as a Rectangle for the node, including its satellites.
`IDiagramGraphic`	`getParent()`
`int`	`getRepresentationMode()` Get the current representation mode.
`java.lang.String`	`getTextColor()` Get the current text color.
`boolean`	`isPrimarySelected()` Returns the selected state of this graphical element.
`boolean`	`isSelected()` Returns the selected state of this graphical element.
`void`	`mask()` Mask the current representation.
`void`	`setBounds(Rectangle newBounds)` This method changes both the location and the size of a node by changing its current bounds.
`void`	`setFillColor(java.lang.String value)` Modify the current fill color.
`void`	`setFillMode(int value)` Modify the current fill mode
`void`	`setFont(java.lang.String value)` Modify the current font.
`void`	`setLineColor(java.lang.String value)` Modify the current line color.
`void`	`setLineWidth(int value)` Modify the current line width.
`boolean`	`setLocation(int x, int y)` Change the location of the node, setting its new position to (x,y).
`void`	`setRepresentationMode(int value)` Modify the current representation mode.
`boolean`	`setSize(int width, int height)` Change the size of the node to (width,height).
`void`	`setTextColor(java.lang.String value)` Modify the current text color.

Methods inherited from interface org.modelio.api.modelio.diagram.IDiagramGraphic
getFromLinks, getHyperLink, getLayer, getLocalPropertyNames, getName, getProperty, getStyle, getToLinks, moveToLayer, normalizeLocalProperties, resetLocalProperties, setHyperLink, setProperty, setStyle

- Method Detail
  - fitToContent
```
void fitToContent()
```
    Resize this diagram node to fit its content.
  - getBounds
```
Rectangle getBounds()
```
    Return the node location and size as a Rectangle.
    
    Returns:
    
    the node bounds.
  - getElement
```
MObject getElement()
```
    Description copied from interface: IDiagramGraphic
    
    Get the element this IDiagramGraphic is related to.
    Note: May return null if the element is not resolved. or the graphic does not represent a model element, such as diagram drawings..
    
    Specified by:
    
    getElement in interface IDiagramGraphic
    
    Returns:
    
    the represented element or null if the element is not resolved.
  - getFillColor
```
java.lang.String getFillColor()
```
    Get the current fill color.
    Might return null if the corresponding style key isn't defined.
    
    Returns:
    
    The fill color.
  - getFillMode
```
int getFillMode()
```
    Get the current fill mode.
    - 0 : The figure must be transparent.
    - 1 : The figure is filled with a solid color.
    - 2 : The figure is filled with a gradient.
    
    Returns:
    
    The fill mode.
  - getFirstNode
```
IDiagramNode getFirstNode(IDiagramNode.Role role)
```
    Get the first child node with the given role.
    To be used when you know at most one element matches the role.
    
    Parameters:
    
    role - the asked role
    
    Returns:
    
    the asked nodes.
    
    Since:
    
    3.5
  - getFont
```
java.lang.String getFont()
```
    Get the current font, represented by font data.
    A valid font data representation is a string of the form fontname-style-height where fontname is the name of a font, style is a font style (one of "regular", "bold", "italic", or "bold italic") and height is an integer representing the font height. Example: Times New Roman-bold-36.
    
    Might return null if the corresponding style key isn't defined.
    
    Returns:
    
    The font.
  - getLineColor
```
java.lang.String getLineColor()
```
    Get the current line color.
    Might return null if the corresponding style key isn't defined.
    
    Returns:
    
    The line color.
  - getLineWidth
```
int getLineWidth()
```
    Get the current line width.
    
    Returns:
    
    The line width.
  - getNodes
```
java.util.List<IDiagramNode> getNodes()
```
    Return the list of children nodes of this node.
    
    Returns:
    
    A list of nodes in any case, possibly an empty one. Never returns null
  - getNodes
```
java.util.Collection<IDiagramNode> getNodes(IDiagramNode.Role role)
```
    Get the child nodes with the given role.
    
    Parameters:
    
    role - the asked role
    
    Returns:
    
    the asked nodes.
    
    Since:
    
    3.5
  - getOverallBounds
```
Rectangle getOverallBounds()
```
    Return the location and size as a Rectangle for the node, including its satellites.
    When no satellites are displayed, returns the same value as getBounds().
    
    Returns:
    
    the node bounds.
    
    Since:
    
    3.1
  - getParent
```
IDiagramGraphic getParent()
```
    Returns:
    
    the parent node.
  - getRepresentationMode
```
int getRepresentationMode()
```
    Get the current representation mode.
    - 0 : simple mode
    - 1 : structured mode
    - 2 : image mode
    
    Returns:
    
    The representation mode.
  - getTextColor
```
java.lang.String getTextColor()
```
    Get the current text color.
    Might return null if the corresponding style key isn't defined.
    
    Returns:
    
    The text color.
  - isPrimarySelected
```
boolean isPrimarySelected()
```
    Description copied from interface: IDiagramGraphic
    
    Returns the selected state of this graphical element.
    
    Specified by:
    
    isPrimarySelected in interface IDiagramGraphic
    
    Returns:
    
    true if the graphical element is the primary selection of the diagram.
  - isSelected
```
boolean isSelected()
```
    Description copied from interface: IDiagramGraphic
    
    Returns the selected state of this graphical element.
    
    Specified by:
    
    isSelected in interface IDiagramGraphic
    
    Returns:
    
    true if the graphical element is selected in the diagram.
  - mask
```
void mask()
```
    Description copied from interface: IDiagramGraphic
    
    Mask the current representation. The associated element is not removed from the model.
    
    Specified by:
    
    mask in interface IDiagramGraphic
  - setBounds
```
void setBounds(Rectangle newBounds)
```
    This method changes both the location and the size of a node by changing its current bounds.
    Note however that the requested change might no be performed when some layout constraints are maintained by the parent of the node (ie the requested changes are refused or adapted by the parent of the node).
    
    Parameters:
    
    newBounds - the new node bounds
  - setFillColor
```
void setFillColor(java.lang.String value)
```
    Modify the current fill color.
    
    Parameters:
    
    value - The new fill color.
  - setFillMode
```
void setFillMode(int value)
```
    Modify the current fill mode. - 0 : The figure must be transparent.
    - 1 : The figure is filled with a solid color.
    - 2 : The figure is filled with a gradient.
    
    Parameters:
    
    value - The new fill mode.
  - setFont
```
void setFont(java.lang.String value)
      throws DataFormatException
```
    Modify the current font.
    This method fails if the value does not represent font data.
    A valid font data representation is a string of the form fontname-style-height where fontname is the name of a font, style is a font style (one of "regular", "bold", "italic", or "bold italic") and height is an integer representing the font height. Example: Times New Roman-bold-36.
    
    Parameters:
    
    value - The new font.
    
    Throws:
    
    DataFormatException - if the given value does not represent font data
  - setLineColor
```
void setLineColor(java.lang.String value)
```
    Modify the current line color.
    
    Parameters:
    
    value - The new line color.
  - setLineWidth
```
void setLineWidth(int value)
```
    Modify the current line width.
    
    Parameters:
    
    value - The new line width.
  - setLocation
```
boolean setLocation(int x,
                    int y)
```
    Change the location of the node, setting its new position to (x,y). Note however that the requested change might no be performed when some layout constraints are maintained by the parent of the node (ie the requested change is refused or adapted by the parent of the node).
    
    Parameters:
    
    x - the new X position
    
    y - the new Y position
    
    Returns:
    
    true if the change could be requested (different from 'performed' see note above)
  - setRepresentationMode
```
void setRepresentationMode(int value)
```
    Modify the current representation mode.
    - 0 : simple mode
    - 1 : structured mode
    - 2 : image mode
    
    Parameters:
    
    value - The new representation mode.
  - setSize
```
boolean setSize(int width,
                int height)
```
    Change the size of the node to (width,height).
    Note however that the requested change might no be performed when some layout constraints are maintained by the parent of the node (ie the requested change is refused or adapted by the parent of the node).
    
    Parameters:
    
    width - the new width
    
    height - the new height
    
    Returns:
    
    true if the change could be requested (different from 'performed' see note above)
  - setTextColor
```
void setTextColor(java.lang.String value)
```
    Modify the current text color.
    
    Parameters:
    
    value - The new text color.

Interface IDiagramNode

Nested Class Summary

Method Summary

Methods inherited from interface org.modelio.api.modelio.diagram.IDiagramGraphic

Method Detail

fitToContent

getBounds

getElement

getFillColor

getFillMode

getFirstNode

getFont

getLineColor

getLineWidth

getNodes

getNodes

getOverallBounds

getParent

getRepresentationMode

getTextColor

isPrimarySelected

isSelected

mask

setBounds

setFillColor

setFillMode

setFont

setLineColor

setLineWidth

setLocation

setRepresentationMode

setSize

setTextColor