|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISCSConvertedDisplayInfo
Used to pass information to the ISCSFileAPI.getDynamicConversion(com.stellent.cis.client.api.scs.context.ISCSContext, com.stellent.cis.client.api.scs.ISCSDocumentID)
and ISCSFileAPI.getDynamicFile(com.stellent.cis.client.api.scs.context.ISCSContext, java.lang.String)
methods
to specify information regarding the rewriting of the converted URLs in the returned HTML.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable |
---|
ICISObjectInitializable.AdapterVersionAware |
Field Summary |
---|
Fields inherited from interface com.stellent.cis.client.api.common.ICISObject |
---|
FILTER_NULL_VALUE, FILTER_READONLY, FILTER_SYSTEM |
Method Summary | |
---|---|
java.lang.String |
getFileEncoding()
|
java.util.Map |
getImageUrlParameters()
|
java.lang.String |
getImageUrlParametersEncoded()
|
java.util.Map |
getPageUrlParameters()
|
java.lang.String |
getPageUrlParametersEncoded()
|
java.lang.String |
getUrlContext()
|
boolean |
isForceClientEncoding()
|
boolean |
isRewriteForDisplay()
|
boolean |
isShowEncodingInHeader()
|
void |
setFileEncoding(java.lang.String encoding)
Used when isRewriteForDisplay() is set, specifies the encoding of the file. |
void |
setForceClientEncoding(boolean forceClientEncoding)
Sets the forceClientEncoding flag |
void |
setImageUrlParameters(java.util.Map parameters)
URL Parameters that will be added to the url |
void |
setPageUrlParameters(java.util.Map parameters)
URL Parameters that will be added to the url for links between pages |
void |
setRewriteForDisplay(boolean rewriteForDisplay)
Set the rewrite for display flag |
void |
setShowEncodingInHeader(boolean showEncodingInHeader)
Sets the showEncodingInHeader flag |
void |
setUrlContext(java.lang.String urlContext)
|
Methods inherited from interface com.stellent.cis.client.api.scs.ISCSObject |
---|
castObject, clearPropertyFilter, copyObject, getPropertyFilter, getSourceAdapter, getSourceObject, getSourceObjectPropertyType, mergeObject, mergeObject, removeProperty, setPropertyFilter, setRestrictedPropertyFilter, setSourceObjectPropertyType |
Methods inherited from interface com.stellent.cis.client.api.common.ICISObject |
---|
getProperties, getPropertiesWithValue, getProperty, getPropertyAsString, getPropertyAsString, getPropertyDescriptors, hasProperty, setProperty, setProperty, setProperty |
Methods inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable |
---|
intialize |
Method Detail |
---|
boolean isRewriteForDisplay()
void setRewriteForDisplay(boolean rewriteForDisplay)
rewriteForDisplay
- set to true if the urls will be rewritten for display, false otherwiseboolean isShowEncodingInHeader()
void setShowEncodingInHeader(boolean showEncodingInHeader)
showEncodingInHeader
- set to true the Content Server will add the name of the encoding to the responseboolean isForceClientEncoding()
void setForceClientEncoding(boolean forceClientEncoding)
forceClientEncoding
- set to true to force the Content Server to write the response back using the client's encodingvoid setImageUrlParameters(java.util.Map parameters)
parameters
- a mapping of String name to String value of URL parameters that will be added to the rewritten URL;
valid only if isRewriteForDisplay()
is enabledjava.util.Map getImageUrlParameters()
java.lang.String getImageUrlParametersEncoded()
void setPageUrlParameters(java.util.Map parameters)
parameters
- a mapping of String name to String value of URL parameters that will be added to the rewritten URL;
valid only if isRewriteForDisplay()
is enabledjava.util.Map getPageUrlParameters()
java.lang.String getPageUrlParametersEncoded()
void setFileEncoding(java.lang.String encoding)
isRewriteForDisplay()
is set, specifies the encoding of the file. If not set, the system
will attempt to determine the encoding to use by looking for a <meta http-equiv="Content-Type" tag
in the HTML file. If not found, the default file system encoding is used.
encoding
- the encoding to use, overwrites any discovery of encodingjava.lang.String getFileEncoding()
setFileEncoding(String)
java.lang.String getUrlContext()
IContext.getContextPath()
is used
from the corresponding ISCSContext
objectvoid setUrlContext(java.lang.String urlContext)
urlContext
- the url context (i.e. the url prefix upto the servlet declaration)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |