Class PageAttachmentResourceReference
- java.lang.Object
-
- org.xwiki.rendering.listener.reference.ResourceReference
-
- org.xwiki.rendering.listener.reference.PageAttachmentResourceReference
-
- All Implemented Interfaces:
Cloneable
public class PageAttachmentResourceReference extends ResourceReference
Represents a reference to an Attachment of a Page.- Since:
- 13.10.5, 14.3RC1
- Version:
- $Id: 0aa46309660cfa9adc43ca938b18610b42cca485 $
-
-
Field Summary
Fields Modifier and Type Field Description static String
ANCHOR
The name of the parameter representing the Anchor.static String
QUERY_STRING
The name of the parameter representing the Query String.
-
Constructor Summary
Constructors Constructor Description PageAttachmentResourceReference(String reference)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getAnchor()
String
getQueryString()
void
setAnchor(String anchor)
void
setQueryString(String queryString)
-
Methods inherited from class org.xwiki.rendering.listener.reference.ResourceReference
addBaseReference, addBaseReferences, clone, equals, getBaseReferences, getParameter, getParameters, getReference, getType, hashCode, isTyped, removeParameter, setParameter, setParameters, setReference, setType, setTyped, toString
-
-
-
-
Field Detail
-
QUERY_STRING
public static final String QUERY_STRING
The name of the parameter representing the Query String.- See Also:
- Constant Field Values
-
ANCHOR
public static final String ANCHOR
The name of the parameter representing the Anchor.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
PageAttachmentResourceReference
public PageAttachmentResourceReference(String reference)
- Parameters:
reference
- seeResourceReference.getReference()
-
-
Method Detail
-
getQueryString
public String getQueryString()
- Returns:
- the query string for specifying parameters that will be used in the rendered URL or null if no query
string has been specified. Example:
mydata1=5&mydata2=Hello
-
setQueryString
public void setQueryString(String queryString)
- Parameters:
queryString
- seegetQueryString()
-
getAnchor
public String getAnchor()
- Returns:
- the anchor name pointing to an anchor defined in the referenced attachment or null if no anchor has been specified (in which case the reference points to the top of the attachment).
-
setAnchor
public void setAnchor(String anchor)
- Parameters:
anchor
- seegetAnchor()
-
-