DimDom v0.8.2

org.alltimeflashdreamer.dimdom
Interface DimDomNode

All Known Implementing Classes:
DimDomNodeImpl

public interface DimDomNode

Title: DimDomNode
Description: This interface collects the supported operations of the DimDom engine that the programmer of the dynamic content is able to use.


Method Summary
 void addData(String sValue)
          Stores a single String value, without selection.
 void addData(String[] sValues)
          Stores a list of String values, without selection.
 void addData(String[][] sValues2D)
          Stores a field (i.e.
 void addData(String[][] sValues2D, int iSelectedRow)
          Stores a field (i.e.
 void addData(String[][] sValues2D, int iSelectedRow, int iSelectedColumn)
          Stores a field (i.e.
 void addData(String[] sValues, int iSelectedIndex)
          Stores a list of String values, with selection index.
 void addData(String[] sValues, String sSelectedEntry)
          Stores a list of String values, with selected string.
 void addData(String sValue, boolean bIsSelected)
          Stores a single String value, with selection.
 void addData(Vector vValues)
          Stores a list of String values, without selection.
 void addData(Vector vValues, int iSelectedIndex)
          Stores a list of String values, with selection index.
 void addData(Vector vValues, String sSelectedEntry)
          Stores a list of String values, with selected string.
 void setAttribute(String sKey, String sValue)
          Sets an attribute key/value pair to the node.
 void setAttribute(String sKey, String sValue, boolean bIsCommon)
          Sets an attribute key/value pair to the node.
 void setChildAttribute(String sKey, String sValue)
          Sets an attribute key/value pair to DimDom-specific child of node.
 void setEmbeddingLink(String sTargetURL)
          Embeds the underlying DOM node with a "a" element and sets the parameter String to the element's "href" attribute.
 void setEmbeddingLink(String sTargetURL, String sTargetFrame)
          Embeds the underlying DOM node with a "a" element and sets the parameter String to the element's "href" attribute.
 void setReplacingText(String sReplacingText)
          Sets the visibility of the DimDomNode to false and updates the replacement value.
 void setVisible(boolean bIsVisible)
          Sets the visibility of the DimDomNode.
 

Method Detail

setAttribute

public void setAttribute(String sKey,
                         String sValue,
                         boolean bIsCommon)
                  throws DimDomException
Sets an attribute key/value pair to the node. If this attribute is already defined for the underlying node, it is replaced during the processing of the template. If the key or the value parameter is not XHTML compliant, a DimDomException is thrown. If the boolean is true, this attribute is added to each node of the same kind as the underlying node.
Parameters:
sKey - the name of the attribute
sValue - the value of the attribute
bIsCommon - whether to set this attribute to each node having the same node name as the template node having this class' node identifier
Throws:
DimDomException - if one of the parameters is not XHTML compliant (see org.w3c.dom.Attr class)

setAttribute

public void setAttribute(String sKey,
                         String sValue)
                  throws DimDomException
Sets an attribute key/value pair to the node. If this attribute is already defined for the underlying node, it is replaced during the processing of the template. If the key or the value parameter is not XHTML compliant, a DimDomException is thrown. This method is designed for individual nodes only.
Parameters:
sKey - the name of the attribute
sValue - the value of the attribute
Throws:
DimDomException - if one of the parameters is not XHTML compliant (see org.w3c.dom.Attr class)

setChildAttribute

public void setChildAttribute(String sKey,
                              String sValue)
                       throws DimDomException
Sets an attribute key/value pair to DimDom-specific child of node. If this attribute is already defined for the child node, it is replaced during the processing of the template. If the key or the value parameter is not XHTML compliant, a DimDomException is thrown. This method is designed for individual nodes only, because DimDom doesn't append children to common nodes.
Parameters:
sKey - the name of the attribute
sValue - the value of the attribute
Throws:
DimDomException - if one of the parameters is not XHTML compliant (see org.w3c.dom.Attr class)

addData

public void addData(String sValue)
Stores a single String value, without selection.
Parameters:
sValue - just a value

addData

public void addData(String sValue,
                    boolean bIsSelected)
Stores a single String value, with selection.
Parameters:
sValue - just a value
bIsSelected - whether to select the value or not

addData

public void addData(String[] sValues)
Stores a list of String values, without selection.
Parameters:
sValues - a value list

addData

public void addData(Vector vValues)
Stores a list of String values, without selection.
Parameters:
vValues - a value list

addData

public void addData(String[] sValues,
                    int iSelectedIndex)
Stores a list of String values, with selection index.
Parameters:
sValues - a value list
iSelectedIndex - an existing index, else nothing is selected

addData

public void addData(String[] sValues,
                    String sSelectedEntry)
Stores a list of String values, with selected string.
Parameters:
sValues - a value list
sSelectedEntry - an existing string of the list, else nothing is selected

addData

public void addData(Vector vValues,
                    int iSelectedIndex)
Stores a list of String values, with selection index.
Parameters:
vValues - a value list
iSelectedIndex - an existing index, else nothing is selected

addData

public void addData(Vector vValues,
                    String sSelectedEntry)
Stores a list of String values, with selected string.
Parameters:
vValues - a value list
sSelectedEntry - an existing string of the list, else nothing is selected

addData

public void addData(String[][] sValues2D)
Stores a field (i.e. a 2-dimensional list) of String values, without selection.
Parameters:
sValues2D - a value field

addData

public void addData(String[][] sValues2D,
                    int iSelectedRow)
Stores a field (i.e. a 2-dimensional list) of String values, with selected row.
Parameters:
sValues2D - a value field
iSelectedRow - each value of this row (starting with 0) will be selected in the output

addData

public void addData(String[][] sValues2D,
                    int iSelectedRow,
                    int iSelectedColumn)
Stores a field (i.e. a 2-dimensional list) of String values, with selected row and column.
Parameters:
sValues2D - a value field
iSelectedRow - the row index (starting with 0) of the selected element
iSelectedColumn - the column index (starting with 0) of the selected element

setVisible

public void setVisible(boolean bIsVisible)
Sets the visibility of the DimDomNode. If hidden, its underlying node is removed from the DOM tree during processing to make it invisible.
Parameters:
bIsVisible - true for visible, false for invisible

setReplacingText

public void setReplacingText(String sReplacingText)
Sets the visibility of the DimDomNode to false and updates the replacement value. If the node is still hidden during processing, its underlying node is replaced with a Text node having the given replacement as text.
Parameters:
sReplacingText - e.g. a simple "-" to demonstrate there is no more of what has been there before

setEmbeddingLink

public void setEmbeddingLink(String sTargetURL)
                      throws DimDomException
Embeds the underlying DOM node with a "a" element and sets the parameter String to the element's "href" attribute. The given string may of course be a JavaScript command or something else.
Parameters:
sTargetURL - the URL string to set to the link's href attribute
Throws:
DimDomException - if the target URL string is not XHTML compliant (see org.w3c.dom.Attr class)

setEmbeddingLink

public void setEmbeddingLink(String sTargetURL,
                             String sTargetFrame)
                      throws DimDomException
Embeds the underlying DOM node with a "a" element and sets the parameter String to the element's "href" attribute. The given string may of course be a JavaScript command or something else.
Parameters:
sTargetURL - the URL string to set to the link's href attribute
sTargetFrame - the browser frame name where the link shall point to
Throws:
DimDomException - if the target URL string is not XHTML compliant (see org.w3c.dom.Attr class)

Copyright (c) 2001/02 by Florian Steinsiepe