NestingLevel (Google Docs API v1-rev20251110-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.docs.v1.model.NestingLevel

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class NestingLevel
extends com.google.api.client.json.GenericJson
```
Contains properties describing the look and feel of a list bullet at a given level of nesting.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Docs API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

NestingLevel()

Constructors
Constructor and Description
`NestingLevel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NestingLevel`	`clone()`
`String`	`getBulletAlignment()` The alignment of the bullet within the space allotted for rendering the bullet.
`String`	`getGlyphFormat()` The format string used by bullets at this level of nesting.
`String`	`getGlyphSymbol()` A custom glyph symbol used by bullets when paragraphs at this level of nesting is unordered.
`String`	`getGlyphType()` The type of glyph used by bullets when paragraphs at this level of nesting is ordered.
`Dimension`	`getIndentFirstLine()` The amount of indentation for the first line of paragraphs at this level of nesting.
`Dimension`	`getIndentStart()` The amount of indentation for paragraphs at this level of nesting.
`Integer`	`getStartNumber()` The number of the first list item at this nesting level.
`TextStyle`	`getTextStyle()` The text style of bullets at this level of nesting.
`NestingLevel`	`set(String fieldName, Object value)`
`NestingLevel`	`setBulletAlignment(String bulletAlignment)` The alignment of the bullet within the space allotted for rendering the bullet.
`NestingLevel`	`setGlyphFormat(String glyphFormat)` The format string used by bullets at this level of nesting.
`NestingLevel`	`setGlyphSymbol(String glyphSymbol)` A custom glyph symbol used by bullets when paragraphs at this level of nesting is unordered.
`NestingLevel`	`setGlyphType(String glyphType)` The type of glyph used by bullets when paragraphs at this level of nesting is ordered.
`NestingLevel`	`setIndentFirstLine(Dimension indentFirstLine)` The amount of indentation for the first line of paragraphs at this level of nesting.
`NestingLevel`	`setIndentStart(Dimension indentStart)` The amount of indentation for paragraphs at this level of nesting.
`NestingLevel`	`setStartNumber(Integer startNumber)` The number of the first list item at this nesting level.
`NestingLevel`	`setTextStyle(TextStyle textStyle)` The text style of bullets at this level of nesting.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - NestingLevel
```
public NestingLevel()
```
- Method Detail
  - getBulletAlignment
```
public String getBulletAlignment()
```
    The alignment of the bullet within the space allotted for rendering the bullet.
    
    Returns:
    
    value or null for none
  - setBulletAlignment
```
public NestingLevel setBulletAlignment(String bulletAlignment)
```
    The alignment of the bullet within the space allotted for rendering the bullet.
    
    Parameters:
    
    bulletAlignment - bulletAlignment or null for none
  - getGlyphFormat
```
public String getGlyphFormat()
```
    The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list.
    
    Returns:
    
    value or null for none
  - setGlyphFormat
```
public NestingLevel setGlyphFormat(String glyphFormat)
```
    The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list.
    
    Parameters:
    
    glyphFormat - glyphFormat or null for none
  - getGlyphSymbol
```
public String getGlyphSymbol()
```
    A custom glyph symbol used by bullets when paragraphs at this level of nesting is unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle.
    
    Returns:
    
    value or null for none
  - setGlyphSymbol
```
public NestingLevel setGlyphSymbol(String glyphSymbol)
```
    A custom glyph symbol used by bullets when paragraphs at this level of nesting is unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle.
    
    Parameters:
    
    glyphSymbol - glyphSymbol or null for none
  - getGlyphType
```
public String getGlyphType()
```
    The type of glyph used by bullets when paragraphs at this level of nesting is ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to the list item's order within the list.
    
    Returns:
    
    value or null for none
  - setGlyphType
```
public NestingLevel setGlyphType(String glyphType)
```
    The type of glyph used by bullets when paragraphs at this level of nesting is ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to the list item's order within the list.
    
    Parameters:
    
    glyphType - glyphType or null for none
  - getIndentFirstLine
```
public Dimension getIndentFirstLine()
```
    The amount of indentation for the first line of paragraphs at this level of nesting.
    
    Returns:
    
    value or null for none
  - setIndentFirstLine
```
public NestingLevel setIndentFirstLine(Dimension indentFirstLine)
```
    The amount of indentation for the first line of paragraphs at this level of nesting.
    
    Parameters:
    
    indentFirstLine - indentFirstLine or null for none
  - getIndentStart
```
public Dimension getIndentStart()
```
    The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction.
    
    Returns:
    
    value or null for none
  - setIndentStart
```
public NestingLevel setIndentStart(Dimension indentStart)
```
    The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction.
    
    Parameters:
    
    indentStart - indentStart or null for none
  - getStartNumber
```
public Integer getStartNumber()
```
    The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs.
    
    Returns:
    
    value or null for none
  - setStartNumber
```
public NestingLevel setStartNumber(Integer startNumber)
```
    The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs.
    
    Parameters:
    
    startNumber - startNumber or null for none
  - getTextStyle
```
public TextStyle getTextStyle()
```
    The text style of bullets at this level of nesting.
    
    Returns:
    
    value or null for none
  - setTextStyle
```
public NestingLevel setTextStyle(TextStyle textStyle)
```
    The text style of bullets at this level of nesting.
    
    Parameters:
    
    textStyle - textStyle or null for none
  - set
```
public NestingLevel set(String fieldName,
                        Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public NestingLevel clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class NestingLevel

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

NestingLevel

Method Detail

getBulletAlignment

setBulletAlignment

getGlyphFormat

setGlyphFormat

getGlyphSymbol

setGlyphSymbol

getGlyphType

setGlyphType

getIndentFirstLine

setIndentFirstLine

getIndentStart

setIndentStart

getStartNumber

setStartNumber

getTextStyle

setTextStyle

set

clone