com.mindfusion.diagramming
Class Row

java.lang.Object
  extended by com.mindfusion.diagramming.Row
All Implemented Interfaces:
java.io.Externalizable, java.io.Serializable, java.lang.Cloneable

public class Row
extends java.lang.Object
implements java.lang.Cloneable, java.io.Externalizable

Represents a row of cells in a table. Rows are the entity to which arrows related to a table are connected.

See Also:
Serialized Form

Constructor Summary
Row()
          Used internally to implement serialization functionality.
Row(TableNode table)
          Initializes a new instance of the Row class and assigns the specified table as its parent.
 
Method Summary
 java.lang.Object clone()
          Copies the row properties to a new Row instance.
 AnchorPattern getAnchorPattern()
          Gets the AnchorPattern assigned to this row.
 boolean getExpanded()
          Gets a value indicating whether the section of rows below this header row is expanded or collapsed.
 boolean getHeader()
          Gets a value indicating whether this row is the header of a section of rows.
 float getHeight()
          Gets the height of this row.
 DiagramLinkList getIncomingLinks()
          Gets a list of all arrows coming into this row.
 DiagramLinkList getOutgoingLinks()
          Gets a list of all arrows going out of this row.
protected  void loadFromXml(org.w3c.dom.Element xmlElement, XmlPersistContext context)
           
 void readExternal(java.io.ObjectInput in)
          Implements Externalizable.
protected  void saveToXml(org.w3c.dom.Element xmlElement, XmlPersistContext context)
           
 void setAnchorPattern(AnchorPattern value)
          Sets the AnchorPattern to whose point arrows should be aligned when connecting to this row.
 void setExpanded(boolean value)
          Expands or collapses the section of rows below this header row.
 void setHeader(boolean value)
          Sets a value indicating whether this row should be the header of a section of rows.
 void setHeight(float value)
          Sets the height of this row and all cells inside it.
 void writeExternal(java.io.ObjectOutput out)
          Implements Externalizable.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Row

public Row(TableNode table)
Initializes a new instance of the Row class and assigns the specified table as its parent.

Parameters:
table - The TableNode that contains this row.

Row

public Row()
Used internally to implement serialization functionality.

Method Detail

clone

public java.lang.Object clone()
Copies the row properties to a new Row instance.

Overrides:
clone in class java.lang.Object
Returns:
The new Row object.

getHeight

public float getHeight()
Gets the height of this row.

Returns:
A float value specifying the row height.

setHeight

public void setHeight(float value)
Sets the height of this row and all cells inside it.

Parameters:
value - A float value specifying the row height.

getHeader

public boolean getHeader()
Gets a value indicating whether this row is the header of a section of rows.

Returns:
true if this row is a header of an expandable section of table rows, otherwise false.

setHeader

public void setHeader(boolean value)
Sets a value indicating whether this row should be the header of a section of rows. Setting the row as a header will automatically create a section of table rows spanning to the next header. Such sections can be collapsed so that only their header row will be visible.

Parameters:
value - true if this row is a header of an expandable section of table rows, otherwise false.

getExpanded

public boolean getExpanded()
Gets a value indicating whether the section of rows below this header row is expanded or collapsed.

Returns:
true if the section of rows that starts from a header row is expanded, otherwise false.

setExpanded

public void setExpanded(boolean value)
Expands or collapses the section of rows below this header row.

Parameters:
value - true if the section of rows that starts from a header row should be expanded, otherwise false.

getIncomingLinks

public DiagramLinkList getIncomingLinks()
Gets a list of all arrows coming into this row.

Returns:
An DiagramLinkList containing the incoming arrows.

getOutgoingLinks

public DiagramLinkList getOutgoingLinks()
Gets a list of all arrows going out of this row.

Returns:
An DiagramLinkList containing the outgoing arrows.

getAnchorPattern

public AnchorPattern getAnchorPattern()
Gets the AnchorPattern assigned to this row.

Returns:
An AnchorPattern object defining the row's anchor points.

setAnchorPattern

public void setAnchorPattern(AnchorPattern value)
Sets the AnchorPattern to whose point arrows should be aligned when connecting to this row.

Parameters:
value - An AnchorPattern object defining the row's anchor points.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Implements Externalizable.

Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Implements Externalizable.

Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException

saveToXml

protected void saveToXml(org.w3c.dom.Element xmlElement,
                         XmlPersistContext context)

loadFromXml

protected void loadFromXml(org.w3c.dom.Element xmlElement,
                           XmlPersistContext context)
                    throws javax.xml.transform.TransformerException
Throws:
javax.xml.transform.TransformerException