|
DimDom v0.8.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.alltimeflashdreamer.dimdom.DimDomNodeImpl
Title: DimDomNodeImpl
Description: This class represents one node that is processed by the DimDom
engine. Its constructor stores the identifier which must exist in the
template file. If the template lacks this String (case-insensitive
comparison), a DimDomException will be thrown on accessing that node.
Inner Class Summary | |
(package private) class |
DimDomNodeImpl.AttributeObject
Description of the Class |
(package private) class |
DimDomNodeImpl.EmbeddingLink
Simple object to stored the set values of an embedding link ("a" element). |
(package private) class |
DimDomNodeImpl.ValueObject
The ValueObject class is abled to store data in the supported formats of DimDom, i.e. |
Constructor Summary | |
DimDomNodeImpl(Document testDocument,
String sNodeIdentifier)
|
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. |
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, without selection. |
void |
addData(Vector vValues,
String sSelectedEntry)
Stores a list of String values, with selected string. |
(package private) DimDomNodeImpl.EmbeddingLink |
getEmbeddingLink()
Returns this class EmbeddingLink instance, if defined |
(package private) DimDomNodeImpl.AttributeObject |
getNextAttributeObject()
Returns an AttributeObject instance to be appended to the underlying node by the DimDom engine. |
(package private) DimDomNodeImpl.ValueObject |
getNextValueObject()
Returns an instance of ValueObject, to allow the DimDom engine to process the next cycle on this class' underlying element/node. |
(package private) String |
getNodeIdentifier()
Returns the value of the id attribute of the underlying (DimDom) node. |
(package private) String |
getReplacingText()
Returns the replacing text of this node. |
(package private) boolean |
hasEmbeddingLink()
Returns whether this node was set to be embedded in a link. |
(package private) boolean |
hasMoreAttributeObjects()
Returns whether there are more instances of Attr in the pipeline or not. |
(package private) boolean |
hasMoreValueObjects()
Returns whether there are more instances of ValueObject in the pipeline or not. |
(package private) boolean |
isVisible()
Returns the visibility of the node. |
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. |
Methods inherited from class java.lang.Object |
|
Constructor Detail |
public DimDomNodeImpl(Document testDocument, String sNodeIdentifier)
sNodeIdentifier
- as defined in the templatetestDocument
- a valid XHTML Document object which is used to
run tests while setting data/attributesMethod Detail |
public void setAttribute(String sKey, String sValue, boolean bIsCommon) throws DimDomException
setAttribute
in interface DimDomNode
sKey
- the name of the attributesValue
- the value of the attributebIsCommon
- whether to set this attribute to each node
having the same node name as the template node having this class'
node identifierDimDomException
- if one of the parameters is not XHTML
compliant (see org.w3c.dom.Attr class)public void setAttribute(String sKey, String sValue) throws DimDomException
setAttribute
in interface DimDomNode
sKey
- the name of the attributesValue
- the value of the attributeDimDomException
- if one of the parameters is not XHTML
compliant (see org.w3c.dom.Attr class)public void setChildAttribute(String sKey, String sValue) throws DimDomException
setChildAttribute
in interface DimDomNode
sKey
- the name of the attributesValue
- the value of the attributeDimDomException
- if one of the parameters is not XHTML
compliant (see org.w3c.dom.Attr class)public void addData(String sValue)
addData
in interface DimDomNode
sValue
- just a valuepublic void addData(String sValue, boolean bIsSelected)
addData
in interface DimDomNode
sValue
- just a valuebIsSelected
- whether to select the value or notpublic void addData(String[] sValues)
addData
in interface DimDomNode
sValues
- a value listpublic void addData(Vector vValues)
addData
in interface DimDomNode
vValues
- a value listpublic void addData(String[] sValues, int iSelectedIndex)
addData
in interface DimDomNode
sValues
- a value listiSelectedIndex
- an existing index, else nothing is selectedpublic void addData(String[] sValues, String sSelectedEntry)
addData
in interface DimDomNode
sValues
- a value listsSelectedEntry
- an existing string of the list, else nothing is
selectedpublic void addData(Vector vValues, int iSelectedIndex)
addData
in interface DimDomNode
vValues
- a value listiSelectedIndex
- an existing index, else nothing is selectedpublic void addData(Vector vValues, String sSelectedEntry)
addData
in interface DimDomNode
vValues
- a value listsSelectedEntry
- an existing string of the list, else nothing is
selectedpublic void addData(String[][] sValues2D)
addData
in interface DimDomNode
sValues2D
- a value fieldpublic void addData(String[][] sValues2D, int iSelectedRow)
addData
in interface DimDomNode
sValues2D
- a value fieldiSelectedRow
- each value of this row (starting with 0) will be
selected in the outputpublic void addData(String[][] sValues2D, int iSelectedRow, int iSelectedColumn)
addData
in interface DimDomNode
sValues2D
- a value fieldiSelectedRow
- the row index (starting with 0) of the selected
elementiSelectedColumn
- the column index (starting with 0) of the
selected elementpublic void setVisible(boolean bIsVisible)
setVisible
in interface DimDomNode
bIsVisible
- true for visible, false for invisiblepublic void setReplacingText(String sReplacingText)
setReplacingText
in interface DimDomNode
sReplacingText
- e.g. a simple "-" to demonstrate there is no more
of what has been there beforepublic void setEmbeddingLink(String sTargetURL) throws DimDomException
setEmbeddingLink
in interface DimDomNode
sTargetURL
- the URL string to set to the link's href
attributeDimDomException
- if the target URL string is not XHTML
compliant (see org.w3c.dom.Attr class)public void setEmbeddingLink(String sTargetURL, String sTargetFrame) throws DimDomException
setEmbeddingLink
in interface DimDomNode
sTargetURL
- the URL string to set to the link's href
attributesTargetFrame
- the browser frame name where the link shall
point toDimDomException
- if the target URL string is not XHTML
compliant (see org.w3c.dom.Attr class)boolean hasMoreValueObjects()
DimDomNodeImpl.ValueObject getNextValueObject()
boolean hasMoreAttributeObjects()
DimDomNodeImpl.AttributeObject getNextAttributeObject()
boolean isVisible()
String getReplacingText()
boolean hasEmbeddingLink()
DimDomNodeImpl.EmbeddingLink getEmbeddingLink()
String getNodeIdentifier()
|
Copyright (c) 2001/02 by Florian Steinsiepe | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |