SetWCMMode (ACS AEM Commons Bundle 4.7.2 API)

java.lang.Object
- javax.servlet.jsp.tagext.TagSupport
- - com.adobe.acs.commons.wcm.tags.wcmmode.SetWCMMode

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
```
@ProviderType
public final class SetWCMMode
extends javax.servlet.jsp.tagext.TagSupport
```
Implementation of the <wcmmode:setMode> tag, this sets the WCMMode to the specified mode and restores it to the original mode.
The following attributes can be specified:
- mode: to mode to be set
- restore: must the original mode be restored (default true)
Example:
<wcmmode:setMode mode="disabled"> ... </wcmmode:setMode>
See Also:

WCMMode, Serialized Form

Field Summary
- Fields inherited from class javax.servlet.jsp.tagext.TagSupport
  id, pageContext
- Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
  EVAL_BODY_AGAIN
- Fields inherited from interface javax.servlet.jsp.tagext.Tag
  EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors
Constructor Description

SetWCMMode()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`doEndTag()`
`int`	`doStartTag()`
`void`	`release()`
`void`	`setMode(String mode)`
`void`	`setRestore(boolean restore)`

Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

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

- Constructor Detail
  - SetWCMMode
```
public SetWCMMode()
```
- Method Detail
  - doStartTag
```
public int doStartTag()
               throws javax.servlet.jsp.JspException
```
    Specified by:
    
    doStartTag in interface javax.servlet.jsp.tagext.Tag
    
    Overrides:
    
    doStartTag in class javax.servlet.jsp.tagext.TagSupport
    
    Throws:
    
    javax.servlet.jsp.JspException
  - doEndTag
```
public int doEndTag()
             throws javax.servlet.jsp.JspException
```
    Specified by:
    
    doEndTag in interface javax.servlet.jsp.tagext.Tag
    
    Overrides:
    
    doEndTag in class javax.servlet.jsp.tagext.TagSupport
    
    Throws:
    
    javax.servlet.jsp.JspException
  - setMode
```
public void setMode(String mode)
```
  - setRestore
```
public void setRestore(boolean restore)
```
  - release
```
public void release()
```
    Specified by:
    
    release in interface javax.servlet.jsp.tagext.Tag
    
    Overrides:
    
    release in class javax.servlet.jsp.tagext.TagSupport