org.eclipse.jst.j2ee.jsp
Interface JSPPropertyGroup

All Superinterfaces:
CompatibilityDescriptionGroup, DescriptionGroup, J2EEEObject

public interface JSPPropertyGroup
extends CompatibilityDescriptionGroup

A representation of the model object 'JSP Property Group'.

Version:
J2EE1.4 The jsp-property-groupType is used to group a number of files so they can be given global property information. All files so described are deemed to be JSP files. The following additional properties can be described: - Control enabling of EL evaluation. - Control enabling of Scripting elements. - Indicate pageEncoding information. - Indicating that a resource is a JSP document - Prelude and Coda automatic includes.

The following features are supported:

See Also:
JspPackage.getJSPPropertyGroup()

Method Summary
 EList getIncludeCodas()
          Returns the value of the 'Include Codas' attribute list.
 EList getIncludePreludes()
          Returns the value of the 'Include Preludes' attribute list.
 java.lang.String getPageEncoding()
          Returns the value of the 'Page Encoding' attribute
 EList getUrlPattern()
          Returns the value of the 'Url Pattern' attribute list.
 boolean isElIgnored()
          Returns the value of the 'El Ignored' attribute.
 boolean isIsXML()
          Returns the value of the 'Is XML' attribute.
 boolean isScriptingInvalid()
          Returns the value of the 'Scripting Invalid' attribute.
 boolean isSetElIgnored()
          Returns whether the value of the 'El Ignored' attribute is set
 boolean isSetIsXML()
          Returns whether the value of the 'Is XML' attribute is set
 boolean isSetScriptingInvalid()
          Returns whether the value of the 'Scripting Invalid' attribute is set
 void setElIgnored(boolean value)
          Sets the value of the 'El Ignored' attribute
 void setIsXML(boolean value)
          Sets the value of the 'Is XML' attribute
 void setPageEncoding(java.lang.String value)
          Sets the value of the 'Page Encoding' attribute
 void setScriptingInvalid(boolean value)
          Sets the value of the 'Scripting Invalid' attribute
 void unsetElIgnored()
          Unsets the value of the 'El Ignored' attribute
 void unsetIsXML()
          Unsets the value of the 'Is XML' attribute
 void unsetScriptingInvalid()
          Unsets the value of the 'Scripting Invalid' attribute
 
Methods inherited from interface org.eclipse.jst.j2ee.common.CompatibilityDescriptionGroup
getDescription, getDisplayName, getLargeIcon, getSmallIcon, setDescription, setDescriptionGen, setDisplayName, setDisplayNameGen, setLargeIcon, setLargeIconGen, setSmallIcon, setSmallIconGen
 
Methods inherited from interface org.eclipse.jst.j2ee.common.DescriptionGroup
getDescriptions, getDisplayNames, getIcons
 

Method Detail

getUrlPattern

public EList getUrlPattern()
Returns the value of the 'Url Pattern' attribute list. The list contents are of type String.

If the meaning of the 'Url Pattern' attribute list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Url Pattern' attribute list.
See Also:
JspPackage.getJSPPropertyGroup_UrlPattern()

isElIgnored

public boolean isElIgnored()
Returns the value of the 'El Ignored' attribute. The default value is "true".

If the meaning of the 'El Ignored' attribute isn't clear, there really should be more of a description here...

Can be used to easily set the isELIgnored property of a group of JSP pages. By default, the EL evaluation is enabled for Web Applications using a Servlet 2.4 or greater web.xml, and disabled otherwise.

Returns:
the value of the 'El Ignored' attribute.
See Also:
isSetElIgnored(), unsetElIgnored(), setElIgnored(boolean), JspPackage.getJSPPropertyGroup_ElIgnored()

setElIgnored

public void setElIgnored(boolean value)
Sets the value of the 'El Ignored' attribute.

Parameters:
value - the new value of the 'El Ignored' attribute.
See Also:
isSetElIgnored(), unsetElIgnored(), isElIgnored()

unsetElIgnored

public void unsetElIgnored()
Unsets the value of the 'El Ignored' attribute.

See Also:
isSetElIgnored(), isElIgnored(), setElIgnored(boolean)

isSetElIgnored

public boolean isSetElIgnored()
Returns whether the value of the 'El Ignored' attribute is set.

Returns:
whether the value of the 'El Ignored' attribute is set.
See Also:
unsetElIgnored(), isElIgnored(), setElIgnored(boolean)

getPageEncoding

public java.lang.String getPageEncoding()
Returns the value of the 'Page Encoding' attribute.

If the meaning of the 'Page Encoding' attribute isn't clear, there really should be more of a description here...

The valid values of page-encoding are those of the pageEncoding page directive. It is a translation-time error to name different encodings in the pageEncoding attribute of the page directive of a JSP page and in a JSP configuration element matching the page. It is also a translation-time error to name different encodings in the prolog of a document in XML syntax and in a JSP configuration element matching the document. It is legal to name the same encoding through mulitple mechanisms.

Returns:
the value of the 'Page Encoding' attribute.
See Also:
setPageEncoding(String), JspPackage.getJSPPropertyGroup_PageEncoding()

setPageEncoding

public void setPageEncoding(java.lang.String value)
Sets the value of the 'Page Encoding' attribute.

Parameters:
value - the new value of the 'Page Encoding' attribute.
See Also:
getPageEncoding()

isScriptingInvalid

public boolean isScriptingInvalid()
Returns the value of the 'Scripting Invalid' attribute. The default value is "true".

If the meaning of the 'Scripting Invalid' attribute isn't clear, there really should be more of a description here...

Can be used to easily disable scripting in a group of JSP pages. By default, scripting is enabled.

Returns:
the value of the 'Scripting Invalid' attribute.
See Also:
isSetScriptingInvalid(), unsetScriptingInvalid(), setScriptingInvalid(boolean), JspPackage.getJSPPropertyGroup_ScriptingInvalid()

setScriptingInvalid

public void setScriptingInvalid(boolean value)
Sets the value of the 'Scripting Invalid' attribute.

Parameters:
value - the new value of the 'Scripting Invalid' attribute.
See Also:
isSetScriptingInvalid(), unsetScriptingInvalid(), isScriptingInvalid()

unsetScriptingInvalid

public void unsetScriptingInvalid()
Unsets the value of the 'Scripting Invalid' attribute.

See Also:
isSetScriptingInvalid(), isScriptingInvalid(), setScriptingInvalid(boolean)

isSetScriptingInvalid

public boolean isSetScriptingInvalid()
Returns whether the value of the 'Scripting Invalid' attribute is set.

Returns:
whether the value of the 'Scripting Invalid' attribute is set.
See Also:
unsetScriptingInvalid(), isScriptingInvalid(), setScriptingInvalid(boolean)

isIsXML

public boolean isIsXML()
Returns the value of the 'Is XML' attribute. The default value is "false".

If the meaning of the 'Is XML' attribute isn't clear, there really should be more of a description here...

If true, denotes that the group of resources that match the URL pattern are JSP documents, and thus must be interpreted as XML documents. If false, the resources are assumed to not be JSP documents, unless there is another property group that indicates otherwise.

Returns:
the value of the 'Is XML' attribute.
See Also:
isSetIsXML(), unsetIsXML(), setIsXML(boolean), JspPackage.getJSPPropertyGroup_IsXML()

setIsXML

public void setIsXML(boolean value)
Sets the value of the 'Is XML' attribute.

Parameters:
value - the new value of the 'Is XML' attribute.
See Also:
isSetIsXML(), unsetIsXML(), isIsXML()

unsetIsXML

public void unsetIsXML()
Unsets the value of the 'Is XML' attribute.

See Also:
isSetIsXML(), isIsXML(), setIsXML(boolean)

isSetIsXML

public boolean isSetIsXML()
Returns whether the value of the 'Is XML' attribute is set.

Returns:
whether the value of the 'Is XML' attribute is set.
See Also:
unsetIsXML(), isIsXML(), setIsXML(boolean)

getIncludePreludes

public EList getIncludePreludes()
Returns the value of the 'Include Preludes' attribute list. The list contents are of type String.

If the meaning of the 'Include Preludes' attribute list isn't clear, there really should be more of a description here...

The include-prelude element is a context-relative path that must correspond to an element in the Web Application. When the element is present, the given path will be automatically included (as in an include directive) at the beginning of each JSP page in this jsp-property-group.

Returns:
the value of the 'Include Preludes' attribute list.
See Also:
JspPackage.getJSPPropertyGroup_IncludePreludes()

getIncludeCodas

public EList getIncludeCodas()
Returns the value of the 'Include Codas' attribute list. The list contents are of type String.

If the meaning of the 'Include Codas' attribute list isn't clear, there really should be more of a description here...

The include-coda element is a context-relative path that must correspond to an element in the Web Application. When the element is present, the given path will be automatically included (as in an include directive) at the end of each JSP page in this jsp-property-group.

Returns:
the value of the 'Include Codas' attribute list.
See Also:
JspPackage.getJSPPropertyGroup_IncludeCodas()