XDOM (Sencha GXT 4.0.1)

java.lang.Object
- com.sencha.gxt.core.client.dom.XDOM

```
public class XDOM
extends Object
```
Provides additional static methods that allow you to manipulate the browser's Document Object Model (DOM).

Several features in this class can have their behavior customized, such as what next ID to create, what is the highest z-index in the application, and how wide to assume that browser scrollbars will be. You can replace the default implementation of this class with your own type that extends it through a replace-with directive in your module file, something like this:
```
 <replace-with class="path.to.my.CustomXDOMImpl">
   <when-type-is class="com.sencha.gxt.core.client.dom.XDOM.XDOMImpl" />
 </replace-with>
```
See Also:
DOM

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class XDOM.XDOMImpl
Actual implementation of any XDOM methods that require the use of fields to track state.

Nested Classes
Modifier and Type	Class and Description
`static class`	`XDOM.XDOMImpl` Actual implementation of any XDOM methods that require the use of fields to track state.

Field Summary

Fields
Modifier and Type Field and Description

static SafeStyles EMPTY_SAFE_STYLE
An empty safe styles instance.

Fields
Modifier and Type	Field and Description
`static SafeStyles`	`EMPTY_SAFE_STYLE` An empty safe styles instance.

Constructor Summary

Constructors
Constructor and Description

XDOM()

Constructors
Constructor and Description
`XDOM()`

Method Summary

Methods
Modifier and Type	Method and Description
`static XElement`	`create(SafeHtml html)` Creates a new element from the given markup.
`static Element`	`createElementNS(String ns, String tag)` Creates an element of the given name space and tag.
`static Element`	`createTextNode(String text)` Creates a text node from the given text.
`static Element`	`getActiveElement()` Returns the last focused element.
`static String`	`getAutoIdPrefix()` Returns the auto id prefix.
`static int`	`getBodyScrollLeft()` Returns the body elements horizontal scroll.
`static int`	`getBodyScrollTop()` Return the body elements vertical scroll.
`static int`	`getDocumentHeight()` Returns the document's height.
`static int`	`getDocumentWidth()` Returns the document width.
`static Element`	`getHead()` Returns the HTML head element.
`static int`	`getScrollBarWidth()` Returns the width of the scroll bar.
`static int`	`getTopZIndex()` Increments and returns the top z-index value.
`static int`	`getTopZIndex(int i)` Increments and returns the top z-index value.
`static String`	`getUniqueId()` Returns an unique id.
`static int`	`getViewHeight(boolean full)` Returns the view height.
`static int`	`getViewportHeight()` Returns the viewport height.
`static Size`	`getViewportSize()` Returns the viewports size.
`static int`	`getViewportWidth()` Returns the viewport width.
`static int`	`getViewWidth(boolean full)` Returns the view width.
`static void`	`setAutoIdPrefix(String autoIdPrefix)` Sets the auto id prefix which is prepended to the auto id counter when generating auto ids (defaults to 'x-auto').

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EMPTY_SAFE_STYLE
```
public static final SafeStyles EMPTY_SAFE_STYLE
```
    An empty safe styles instance.
- Constructor Detail
  - XDOM
```
public XDOM()
```
- Method Detail
  - create
```
public static XElement create(SafeHtml html)
```
    Creates a new element from the given markup.
    
    Parameters:
    html - the markup
    
    Returns:
    the new element
  - createElementNS
```
public static Element createElementNS(String ns,
                      String tag)
```
    Creates an element of the given name space and tag.
    
    Parameters:
    ns - the name space of the element
    tag - the tag of the element
    
    Returns:
    name space element
  - createTextNode
```
public static Element createTextNode(String text)
```
    Creates a text node from the given text.
    
    Parameters:
    text - the text to insert inside the node
    
    Returns:
    text node
  - getActiveElement
```
public static Element getActiveElement()
```
    Returns the last focused element. This will be null or the body element if no element currently has focus, depending on the browser. See https://developer.mozilla.org/en-US/docs/Web/API/document.activeElement for more details. In some cases, IE9 & MSEdge will throw an exception when accessing activeElement (see footnote 1) so we need to trap for that and return a null value instead.
    
    Returns:
    the last focused element
  - getAutoIdPrefix
```
public static String getAutoIdPrefix()
```
    Returns the auto id prefix.
    
    Returns:
    the auto id prefix
  - getBodyScrollLeft
```
public static int getBodyScrollLeft()
```
    Returns the body elements horizontal scroll.
    
    Returns:
    the scroll amount in pixels
  - getBodyScrollTop
```
public static int getBodyScrollTop()
```
    Return the body elements vertical scroll.
    
    Returns:
    the scroll amount in pixels
  - getDocumentHeight
```
public static int getDocumentHeight()
```
    Returns the document's height.
    
    Returns:
    the document height
  - getDocumentWidth
```
public static int getDocumentWidth()
```
    Returns the document width.
    
    Returns:
    the document width
  - getHead
```
public static Element getHead()
```
    Returns the HTML head element.
    
    Returns:
    the head
  - getScrollBarWidth
```
public static int getScrollBarWidth()
```
    Returns the width of the scroll bar.
    
    Returns:
    the scroll bar width
  - getTopZIndex
```
public static int getTopZIndex()
```
    Increments and returns the top z-index value. Use this value to ensure the z-index is the highest value of all elements in the DOM.
    
    Returns:
    the z-index
  - getTopZIndex
```
public static int getTopZIndex(int i)
```
    Increments and returns the top z-index value. Use this value to ensure the z-index is the highest value of all elements in the DOM.
    
    Parameters:
    i - the increment amount
    
    Returns:
    the z-index
  - getUniqueId
```
public static String getUniqueId()
```
    Returns an unique id.
    
    Returns:
    the id
  - getViewHeight
```
public static int getViewHeight(boolean full)
```
    Returns the view height.
    
    Parameters:
    full - true to return the document height, false for viewport height
    
    Returns:
    the view height
  - getViewportHeight
```
public static int getViewportHeight()
```
    Returns the viewport height.
    
    Returns:
    the viewport height
  - getViewportSize
```
public static Size getViewportSize()
```
    Returns the viewports size.
    
    Returns:
    the viewport size
  - getViewportWidth
```
public static int getViewportWidth()
```
    Returns the viewport width.
    
    Returns:
    the viewport width
  - getViewWidth
```
public static int getViewWidth(boolean full)
```
    Returns the view width.
    
    Parameters:
    full - true to return the document width, false for viewport width
    
    Returns:
    the view width
  - setAutoIdPrefix
```
public static void setAutoIdPrefix(String autoIdPrefix)
```
    Sets the auto id prefix which is prepended to the auto id counter when generating auto ids (defaults to 'x-auto').
    
    Parameters:
    autoIdPrefix - the auto id prefix

Class XDOM

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_SAFE_STYLE

Constructor Detail

XDOM

Method Detail

create

createElementNS

createTextNode

getActiveElement

getAutoIdPrefix

getBodyScrollLeft

getBodyScrollTop

getDocumentHeight

getDocumentWidth

getHead

getScrollBarWidth

getTopZIndex

getTopZIndex

getUniqueId

getViewHeight

getViewportHeight

getViewportSize

getViewportWidth

getViewWidth

setAutoIdPrefix