|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DigitalAssetChooserRenderingContext
DigitalAssetChooserRenderingContext interface to allow a plugin to provide/render the necessary markup/javascript to render the DAM workspace and allow one to select a DigitalAsset.
Nested Class Summary | |
---|---|
static class |
DigitalAssetChooserRenderingContext.FormMode
Current form mode |
static class |
DigitalAssetChooserRenderingContext.ResourceType
Resource type |
Field Summary | |
---|---|
static java.lang.String |
ATTRIBUTE_DIGITALASSET_RENDERING_CONTEXT
digital asset rendering context request attribute name |
Method Summary | |
---|---|
java.lang.String |
encodeName(java.lang.String name)
Encodes the name as necessary for use in environments that require unique names for namespace resolution. |
java.lang.String |
encodeURL(java.lang.String url)
Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged. |
java.lang.Object |
getAttribute(java.lang.String attributeName)
Returns the value of the named attribute as an Object or null if no attribute of the given name exists. |
java.util.Iterator<java.lang.String> |
getAttributeNames()
Returns an Enumeration containing the names of the attributes available to this request. |
Identity<TemplatedDocument> |
getContentTemplateID()
Get the Content Template ID of the currently opened content item. |
javax.servlet.http.Cookie[] |
getCookies()
Returns an array containing all of the Cookie
objects the client sent with the request. |
DigitalAssetChooserRenderingContext.FormMode |
getFormMode()
How/where this rendering of the DigitalAssetChooser will be show. |
java.lang.String |
getID()
ID of the DigitalAssetChooser widget |
java.util.Locale |
getLocale()
Returns the locale to be used during the rendering. |
javax.servlet.jsp.PageContext |
getPageContext()
Get the pageContext |
DigitalAssetChooserRenderingContext.ResourceType |
getResourceType()
Type of Component (file or Image) that the DigitalAssetChooser will be picking/selecting. |
javax.servlet.http.HttpSession |
getSession()
Returns the current HttpSession associated with the request or, if there is no current session returns null; |
java.io.Writer |
getWriter()
Retrieves the writer for this render request. |
void |
include(java.lang.String path)
Includes the content of a resource (servlet, JSP page, HTML file) in the response. |
void |
include(java.lang.String context,
java.lang.String path)
Includes the content of a resource (servlet, JSP page, HTML file) in the response. |
void |
include(java.lang.String context,
java.lang.String path,
java.util.Map<java.lang.String,java.lang.Object> additionalRequestAttributes)
Includes the content of a resource (servlet, JSP page, HTML file) in the response. |
boolean |
isEditable()
Indicates if the DigitalAssetChooser is enabled/editable |
Field Detail |
---|
static final java.lang.String ATTRIBUTE_DIGITALASSET_RENDERING_CONTEXT
Method Detail |
---|
java.util.Locale getLocale()
java.lang.String encodeName(java.lang.String name)
The the name will be encode via getID() + "_" + name, @see getID()
name
- the name to encode
java.lang.String encodeURL(java.lang.String url)
For robust session tracking, all URLs emitted by a servlet should be run through this method. Otherwise, URL rewriting cannot be used with browsers which do not support cookies.
The default behavior of this method is to return encodeURL(String url) on the wrapped response.
url
- the url to be encoded
java.lang.Object getAttribute(java.lang.String attributeName)
attributeName
- - name of the attribute to retieve
null
if no attribute with
the given name exists.java.util.Iterator<java.lang.String> getAttributeNames()
javax.servlet.http.Cookie[] getCookies()
Cookie
objects the client sent with the request.
This method returns null
if no cookies were sent.
Cookies
included with the request, or null
if the request has no cookiesjavax.servlet.http.HttpSession getSession()
null
if no session exists.javax.servlet.jsp.PageContext getPageContext()
void include(java.lang.String path) throws java.io.IOException, javax.servlet.ServletException
The ServletResponse object has its path elements and parameters remain unchanged from the caller's. The included servlet cannot change the response status code or set headers; any attempt to make a change is ignored.
The url parameter may need to be encoded to work properly.
path
- a String
specifying the pathname
to the resource
javax.servlet.ServletException
- if the included resource throws this exception
java.io.IOException
- if the included resource throws this exceptionencodeURL(java.lang.String)
void include(java.lang.String context, java.lang.String path) throws java.io.IOException, javax.servlet.ServletException
The ServletResponse object has its path elements and parameters remain unchanged from the caller's. The included servlet cannot change the response status code or set headers; any attempt to make a change is ignored.
The url parameter may need to be encoded to work properly.
context
- a String
specifying the context root to the application
to which the resource belongs, may be null
if path is in the current applicaitonpath
- a String
specifying the pathname
to the resource
javax.servlet.ServletException
- if the included resource throws this exception
java.io.IOException
- if the included resource throws this exceptionencodeURL(java.lang.String)
void include(java.lang.String context, java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> additionalRequestAttributes) throws java.io.IOException, javax.servlet.ServletException
The ServletResponse object has its path elements and parameters remain unchanged from the caller's. The included servlet cannot change the response status code or set headers; any attempt to make a change is ignored.
The url parameter may need to be encoded to work properly.
context
- a String
specifying the context root to the application
to which the resource belongs, may be null
if path is in the current applicaitonpath
- a String
specifying the pathname
to the resourceadditionalRequestAttributes
- additional parameters to be added to the included request
javax.servlet.ServletException
- if the included resource throws this exception
java.io.IOException
- if the included resource throws this exceptionencodeURL(java.lang.String)
DigitalAssetChooserRenderingContext.ResourceType getResourceType()
The DigitalAssetChooser may wish to limit the type of asset shown based on this. Or change the Display/rendition of the assets.
DigitalAssetChooserRenderingContext.FormMode getFormMode()
For instance in a Dialog a chooser should initially limit its UI, while in a Form it may wish to show asset selection inline, rather then forcing an additional launch/dialog button.
java.lang.String getID()
boolean isEditable()
java.io.Writer getWriter() throws java.io.IOException
include(String)
methods.
java.io.IOException
- is any error occurs getting the underlying WriterIdentity<TemplatedDocument> getContentTemplateID()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |