XMLContainer (com.hfg API Documentation)

All Superinterfaces:

Cloneable, XMLizable

All Known Subinterfaces:

HTMLNode, SvgNode, XMLNode

All Known Implementing Classes:

AbstractSvgNode, Applet, Area, Body, Center, CheckboxSpan, ClickLabelSpan, Col, Colgroup, CreativeCommons_Work, Div, DmlBevelLineJoin, DmlBlip, DmlBlipFill, DmlColor, DmlColorScheme, DmlEffect, DmlEffectRef, DmlEffectStyle, DmlExtents, DmlFill, DmlFillRef, DmlFontRef, DmlFontScheme, DmlFormatScheme, DmlGradientFill, DmlGradientStop, DmlGraphic, DmlGraphicData, DmlGraphicFrameLocks, DmlLine, DmlLineDash, DmlLineEnd, DmlLineHeadEnd, DmlLineJoin, DmlLineRef, DmlLineTailEnd, DmlMajorFont, DmlMinorFont, DmlMiterLineJoin, DmlNoFill, DmlNonVisualDrawingProperties, DmlNonVisualPictureDrawingProperties, DmlNonVisualPictureProperties, DmlNonVisualShapeDrawingProperties, DmlNonVisualShapeProperties, DmlParagraph, DmlPicture, DmlPictureLocks, DmlPresetGeometry, DmlPresetLineDash, DmlRoundLineJoin, DmlSchemeColor, DmlShape, DmlShapeAdjustValues, DmlShapeProperties, DmlSolidFill, DmlSrcRect, DmlSRGBColor, DmlStretch, DmlText, DmlTextBody, DmlTextBodyProperties, DmlTextRun, DmlTextRunProperties, DmlTheme, DmlThemeElements, DmlTransform, DublinCore, DublinCore_Format, DublinCore_Title, DublinCore_Type, Em, ExcelBorder, ExcelCell, ExcelColumn, ExcelComment, ExcelData, ExcelFont, ExcelRow, ExcelStyle, ExcelTable, ExcelWorkbook, ExcelWorksheet, ExcelWorksheetOptions, Form, Frame, Frameset, H1, H2, H3, Head, Hr, HTML, HTMLTag, HTMLTagWithCoreEvents, HTMLTagWithFormEvents, IEConditionalComment, IFrame, ImageMap, Img, InputButton, InputCheckbox, InputFile, InputHidden, InputPassword, InputRadio, InputReset, InputSubmit, InputText, Label, Li, Link, Meta, MultiSelectExpander, Nobr, ObjectTag, OfficeOpenXMLTag, Ol, OptGroup, Option, P, Param, Pre, RDF, Script, Select, Span, SsDrawAbsoluteAnchor, SsDrawDrawingAnchor, SsDrawNonVisualDrawingProperties, SsDrawNonVisualShapeDrawingProperties, SsDrawNonVisualShapeProperties, SsDrawOneCellAnchor, SsDrawShape, SsDrawShapeProperties, SsDrawShapeStyle, SsDrawTextBody, SsDrawTwoCellAnchor, SsmlAlignment, SsmlBorder, SsmlCell, SsmlCellFormat, SsmlCellStyle, SsmlCfColorScaleRule, SsmlCfRule, SsmlCol, SsmlColorScale, SsmlConditionalFormatting, SsmlDataBar, SsmlDataValidation, SsmlDifferentialFormat, SsmlExtension, SsmlFill, SsmlFont, SsmlHeaderFooter, SsmlNumberFormat, SsmlPageMargins, SsmlPane, SsmlRow, SsmlSheetData, SsmlSheetFormatProperties, SsmlSheetView, SsmlSortState, SsmlStyleFormat, SsmlTable, SsmlTextRun, SsmlTextRunProperties, SsmlWorkbook, SsmlWorkbookProperties, SsmlWorkbookView, SsmlWorksheet, SsmlXMLTag, StyleTag, SVG, SvgCircle, SvgDefs, SvgDesc, SvgEllipse, SvgFeBlend, SvgFeColorMatrix, SvgFeComponentTransfer, SvgFeComposite, SvgFeConvolveMatrix, SvgFeDiffuseLighting, SvgFeDisplacementMap, SvgFeDistantLight, SvgFeFlood, SvgFeFunc, SvgFeFuncA, SvgFeFuncB, SvgFeFuncG, SvgFeFuncR, SvgFeGaussianBlur, SvgFeImage, SvgFeMerge, SvgFeMergeNode, SvgFeMorphology, SvgFeOffset, SvgFePointLight, SvgFeSpecularLighting, SvgFeSpotLight, SvgFeTile, SvgFeTurbulence, SvgFilter, SvgForeignObject, SvgGroup, SvgLightSource, SvgLine, SvgLink, SvgMarker, SvgMetadata, SvgPath, SvgPolygon, SvgPolyline, SvgRect, SvgScript, SvgSwitch, SvgSymbol, SvgText, SvgTitle, SvgTSpan, SvgUse, TabbedPaneSet, Table, TBody, Td, Textarea, TextareaExpander, TFoot, Th, THead, Tr, Ul, WmlAbstractNumbering, WmlBody, WmlBorder, WmlCharacterStyle, WmlComments, WmlCommonDrawingMLNonVisualProperties, WmlComplexField, WmlContentContainer, WmlDocDefaults, WmlDrawing, WmlDrawingObjNonVisualProperties, WmlEffectExtent, WmlFooter, WmlHeader, WmlHyperlink, WmlIndentation, WmlInline, WmlLineBorder, WmlList, WmlListProperties, WmlNumberingLevelDef, WmlNumberingProperties, WmlNumberingStyle, WmlOrderedList, WmlPageMargins, WmlPageSize, WmlParagraph, WmlParagraphBorder, WmlParagraphProperties, WmlParagraphStyle, WmlSectionProperties, WmlShading, WmlSimpleField, WmlSpacing, WmlStructuredDocumentTag, WmlStructuredDocumentTagContent, WmlStructuredDocumentTagEndProperties, WmlStructuredDocumentTagProperties, WmlStyle, WmlStyles, WmlSubDoc, WmlTab, WmlTable, WmlTableBorders, WmlTableCell, WmlTableCellBorders, WmlTableCellMargins, WmlTableCellProperties, WmlTableProperties, WmlTableRow, WmlTableRowProperties, WmlTableStyle, WmlTableStyleProperties, WmlText, WmlTextBorder, WmlTextRun, WmlTextRunProperties, WmlUnorderedList, WmlXMLTag, WorksheetDrawing, XMLContainerImpl, XMLTag
```
public interface XMLContainer
extends XMLizable
```
Interface for an unusual XML object that may have content or subtags but not a name or attributes (for example an IE conditional comment in HTML). Such objects are not true XML tags but this can be a useful abstraction for constructing HTML.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`XMLContainer`	`addContent(CharSequence inContent)`
`XMLContainer`	`addContentWithoutEscaping(CharSequence inContent)`
`void`	`addSubtag(XMLizable inSubtag)`
`void`	`addSubtags(Collection<? extends XMLizable> inSubtags)`
`void`	`clearContent()` Clears content (not subtags).
`void`	`clearSubtags()` Removes all subtags from this object.
`String`	`getContent()` The returned content does not contain any embedded subtags.
`XMLContainer`	`getNextSibling()` Returns the next sibling XMLContainer of this XMLContainer.
`<T extends XMLNode> T`	`getOptionalSubtagByName(String inTagName)` Returns the subtag of the specified tag name.
`<T extends XMLNode> T`	`getOptionalSubtagByName(XMLName inTagName)` Returns the subtag of the specified tag name.
`XMLContainer`	`getParentNode()` Returns the parent XMLContainer of this XMLContainer.
`XMLContainer`	`getPreviousSibling()` Returns the previous sibling XMLContainer of this XMLContainer.
`<T extends XMLNode> T`	`getRequiredSubtagByName(String inTagName)` Returns the subtag of the specified tag name.
`<T extends XMLNode> T`	`getRequiredSubtagByName(XMLName inTagName)` Returns the subtag of the specified tag name.
`<T extends XMLizable> List<T>`	`getSubtags()` Returns a List of all subtags on this object.
`<T extends XMLNode> List<T>`	`getSubtagsByName(String inTagName)` Returns a List of all subtags with the specified tag name on this XMLTag object.
`<T extends XMLNode> List<T>`	`getSubtagsByName(String inTagName, Recursion inRecursion)` Returns a List of all subtags with the specified tag name on this XMLTag object.
`<T extends XMLNode> List<T>`	`getSubtagsByName(XMLName inTagName)` Returns a List of all subtags with the specified tag name on this XMLTag object.
`<T extends XMLNode> List<T>`	`getSubtagsByName(XMLName inTagName, Recursion inRecursion)` Returns a List of all subtags with the specified tag name on this XMLTag object.
`int`	`getTotalTagCount()` Returns a count of the total number of tags, including this root tag, its subtags, the subtags' subtags, etc.
`String`	`getUnescapedContent()` Expands character entities before retuning the content of this XMLTag.
`<T extends XMLNode> List<T>`	`getXMLNodeSubtags()` Returns a List of all subtags on this object that implement XMLNode.
`boolean`	`hasContent()`
`int`	`indexOf(XMLizable inSubtag)` Returns the index of the specified subtag.
`void`	`removeSubtag(XMLizable inSubtag)` Removes all instances of the specified subtag from this object.
`<T extends XMLNode> List<T>`	`removeSubtagsByName(String inTagName)` Removes all subtags with the specified tag name from this XMLTag object.
`<T extends XMLNode> List<T>`	`removeSubtagsByName(XMLName inTagName)` Removes all subtags with the specified tag name from this XMLTag object.
`XMLContainer`	`setContent(CharSequence inContent)`
`void`	`setParentNode(XMLContainer inParent)` Specifies the parent XMLContainer of this XMLContainer.
`<T extends XMLizable> void`	`setSubtags(List<T> inSubtags)` Sets the subtags of this object to those specified.

Methods inherited from interface com.hfg.xml.XMLizable
clone, toIndentedXML, toIndentedXML, toIndentedXML, toXML, toXML, toXML

- Method Detail
  - hasContent
```
boolean hasContent()
```
  - setContent
```
XMLContainer setContent(CharSequence inContent)
```
  - clearContent
```
void clearContent()
```
    Clears content (not subtags).
  - addContent
```
XMLContainer addContent(CharSequence inContent)
```
  - addContentWithoutEscaping
```
XMLContainer addContentWithoutEscaping(CharSequence inContent)
```
  - getContent
```
String getContent()
```
    The returned content does not contain any embedded subtags.
    
    Returns:
    
    the XML tag's content stripped of any subtags
  - getUnescapedContent
```
String getUnescapedContent()
```
    Expands character entities before retuning the content of this XMLTag. The returned content does not contain any embedded subtags.
    
    Returns:
    
    the XML tag's unescaped content stripped of any subtags
  - addSubtag
```
void addSubtag(XMLizable inSubtag)
```
  - addSubtags
```
void addSubtags(Collection<? extends XMLizable> inSubtags)
```
    Parameters:
    
    inSubtags - Collection that should only contain XMLNode objects.
  - setSubtags
```
<T extends XMLizable> void setSubtags(List<T> inSubtags)
```
    Sets the subtags of this object to those specified.
    
    Parameters:
    
    inSubtags - the list of subtags to be added to this XML tag
  - getSubtags
```
<T extends XMLizable> List<T> getSubtags()
```
    Returns a List of all subtags on this object.
    
    Returns:
    
    the list of subtags (inclusive of XML comments)
  - getXMLNodeSubtags
```
<T extends XMLNode> List<T> getXMLNodeSubtags()
```
    Returns a List of all subtags on this object that implement XMLNode. Useful as a way to avoid XML comments, etc.
    
    Returns:
    
    the list of subtags (exclusive of XML comments)
  - removeSubtag
```
void removeSubtag(XMLizable inSubtag)
```
    Removes all instances of the specified subtag from this object.
    
    Parameters:
    
    inSubtag - the subtag to be removed
  - clearSubtags
```
void clearSubtags()
```
    Removes all subtags from this object.
  - indexOf
```
int indexOf(XMLizable inSubtag)
```
    Returns the index of the specified subtag.
    
    Parameters:
    
    inSubtag - the subtag for which to determine the index
    
    Returns:
    
    the index of the specified subtag or -1 if this tag does not contain the specified subtag.
  - getRequiredSubtagByName
```
<T extends XMLNode> T getRequiredSubtagByName(String inTagName)
```
    Returns the subtag of the specified tag name.
    
    Parameters:
    
    inTagName - the name of the required subtag
    
    Returns:
    
    the subtag with the specified name
    
    Throws:
    
    XMLException - if zero or more than one subtag with the specified tag name is found.
  - getRequiredSubtagByName
```
<T extends XMLNode> T getRequiredSubtagByName(XMLName inTagName)
```
    Returns the subtag of the specified tag name.
    
    Parameters:
    
    inTagName - the name of the required subtag
    
    Returns:
    
    the subtag with the specified name
    
    Throws:
    
    XMLException - if zero or more than one subtag with the specified tag name is found.
  - getOptionalSubtagByName
```
<T extends XMLNode> T getOptionalSubtagByName(String inTagName)
```
    Returns the subtag of the specified tag name.
    
    Parameters:
    
    inTagName - the name of the optional subtag
    
    Returns:
    
    the subtag with the specified name
    
    Throws:
    
    XMLException - if more than one subtag with the specified tag name is found.
  - getOptionalSubtagByName
```
<T extends XMLNode> T getOptionalSubtagByName(XMLName inTagName)
```
    Returns the subtag of the specified tag name.
    
    Parameters:
    
    inTagName - the name of the optional subtag
    
    Returns:
    
    the subtag with the specified name
    
    Throws:
    
    XMLException - if more than one subtag with the specified tag name is found.
  - getSubtagsByName
```
<T extends XMLNode> List<T> getSubtagsByName(String inTagName)
```
    Returns a List of all subtags with the specified tag name on this XMLTag object.
    
    Parameters:
    
    inTagName - the name of the requested subtags
    
    Returns:
    
    the list of requested subtags
  - getSubtagsByName
```
<T extends XMLNode> List<T> getSubtagsByName(XMLName inTagName)
```
    Returns a List of all subtags with the specified tag name on this XMLTag object.
    
    Parameters:
    
    inTagName - the name of the requested subtags
    
    Returns:
    
    the list of requested subtags
  - getSubtagsByName
```
<T extends XMLNode> List<T> getSubtagsByName(String inTagName,
                                             Recursion inRecursion)
```
    Returns a List of all subtags with the specified tag name on this XMLTag object.
    
    Parameters:
    
    inTagName - the name of the requested subtags
    
    inRecursion - flag to indicate whether or not recursion should be used
    
    Returns:
    
    the list of requested subtags
  - getSubtagsByName
```
<T extends XMLNode> List<T> getSubtagsByName(XMLName inTagName,
                                             Recursion inRecursion)
```
    Returns a List of all subtags with the specified tag name on this XMLTag object.
    
    Parameters:
    
    inTagName - the name of the requested subtags
    
    inRecursion - flag to indicate whether or not recursion should be used
    
    Returns:
    
    the list of requested subtags
  - removeSubtagsByName
```
<T extends XMLNode> List<T> removeSubtagsByName(String inTagName)
```
    Removes all subtags with the specified tag name from this XMLTag object.
    
    Parameters:
    
    inTagName - the name of the subtags to remove
    
    Returns:
    
    the list of removed subtags
  - removeSubtagsByName
```
<T extends XMLNode> List<T> removeSubtagsByName(XMLName inTagName)
```
    Removes all subtags with the specified tag name from this XMLTag object.
    
    Parameters:
    
    inTagName - the name of the subtags to remove
    
    Returns:
    
    the list of removed subtags
  - getTotalTagCount
```
int getTotalTagCount()
```
    Returns a count of the total number of tags, including this root tag, its subtags, the subtags' subtags, etc.
    
    Returns:
    
    the total number of XML tags below and including this tag
  - setParentNode
```
void setParentNode(XMLContainer inParent)
```
    Specifies the parent XMLContainer of this XMLContainer. Top level objects should not have a parent.
    
    Parameters:
    
    inParent - the XML node for which this tag should be a subnode
  - getParentNode
```
XMLContainer getParentNode()
```
    Returns the parent XMLContainer of this XMLContainer. Top level objects should return null.
    
    Returns:
    
    the parent XML node of this node
  - getPreviousSibling
```
XMLContainer getPreviousSibling()
```
    Returns the previous sibling XMLContainer of this XMLContainer. Returns null if no sibling precedes this object.
    
    Returns:
    
    the previous sibling XMLContainer of this XMLContainer. Returns null if no sibling follows this object.
  - getNextSibling
```
XMLContainer getNextSibling()
```
    Returns the next sibling XMLContainer of this XMLContainer. Returns null if no sibling follows this object.
    
    Returns:
    
    the next sibling XMLContainer of this XMLContainer. Returns null if no sibling follows this object.

Interface XMLContainer

Method Summary

Methods inherited from interface com.hfg.xml.XMLizable

Method Detail

hasContent

setContent

clearContent

addContent

addContentWithoutEscaping

getContent

getUnescapedContent

addSubtag

addSubtags

setSubtags

getSubtags

getXMLNodeSubtags

removeSubtag

clearSubtags

indexOf

getRequiredSubtagByName

getRequiredSubtagByName

getOptionalSubtagByName

getOptionalSubtagByName

getSubtagsByName

getSubtagsByName

getSubtagsByName

getSubtagsByName

removeSubtagsByName

removeSubtagsByName

getTotalTagCount

setParentNode

getParentNode

getPreviousSibling

getNextSibling