public class IncludeOptions
extends java.lang.Object
IncludeOptions
provide constants for the next component includeModifier and Type | Field and Description |
---|---|
static java.lang.String |
ATTR_NAME
Name of the request attribute
|
Constructor and Description |
---|
IncludeOptions() |
Modifier and Type | Method and Description |
---|---|
static IncludeOptions |
clear(ServletRequest req)
Clears the include options from the request attributes and returns it.
|
IncludeOptions |
forceCellName(java.lang.String cellName)
Sets the option to force the cell name of the next include
|
IncludeOptions |
forceCurrentPage(Page currentPage)
Sets the option to force a particular current page for the next include.
|
void |
forceEditContext(boolean forceEditContext)
Define if a new edit context should be openend.
|
IncludeOptions |
forceSameContext(boolean force)
Sets the option to force the next include to be in the same edit context
as the current one.
|
java.lang.String |
getCellName()
Returns the cell name for the next include.
|
java.util.Set<java.lang.String> |
getCssClassNames()
Returns a modifiable set of additional css class names to be added to the
including <div> tag.
|
Page |
getCurrentPage()
Returns the currentPage for the next include if forced, or null.
|
java.lang.String |
getDecorationTagName()
Returns the decoration tag name override.
|
static IncludeOptions |
getOptions(ServletRequest req,
boolean force)
Returns the include options as stored in the current request.
|
boolean |
isForceEditContext()
Checks a new edit context is forced.
|
boolean |
isSameContext()
Checks if the same edit context is requested.
|
void |
setDecorationTagName(java.lang.String decorationTagName)
Sets the decoration tag name override.
|
public static IncludeOptions getOptions(ServletRequest req, boolean force)
force
is true
,
new include options are created and stored as request attribute.req
- the requestforce
- flag to force creationnull
public static IncludeOptions clear(ServletRequest req)
req
- the requestnull
if never defined.public IncludeOptions forceSameContext(boolean force)
force
- true
if no new edit context is to be created.public boolean isSameContext()
true
if the next include should use the same edit
context.public IncludeOptions forceCurrentPage(Page currentPage)
currentPage
- the forced pagepublic Page getCurrentPage()
null
public IncludeOptions forceCellName(java.lang.String cellName)
cellName
- the cell namepublic java.lang.String getCellName()
null
public java.util.Set<java.lang.String> getCssClassNames()
public boolean isForceEditContext()
true
if forced.public void forceEditContext(boolean forceEditContext)
forceEditContext
- true
if a new edit context
should be openend.public java.lang.String getDecorationTagName()
public void setDecorationTagName(java.lang.String decorationTagName)
decorationTagName
- the decoration tag name.ComponentContext.setDecorationTagName(String)
Copyright © 2010 - 2020 Adobe. All Rights Reserved