:: com :: sun :: star :: uri ::
|
interface XVndSunStarScriptUrl |
|
- Description
- represents absolute “vnd.sun.star.script” URLs.
These URLs are of the form
vnd-sun-star-script-url =
"VND.SUN.STAR.SCRIPT:" name ["?"
parameter *("&" parameter)]
name = 1*schar
parameter = key "="
value
key = 1*schar
value = *schar
schar = unreserved / escaped /
"$" / "+" / "," / ":" /
";" / "@" / "[" /
"]"
See RFC 2396,
RFC 2732, and
RFC 2234 for
details.
The names, keys, and values are arbitrary Unicode strings (non-empty
Unicode strings in the case of names and keys), encoded as UTF-8 byte
sequences. It is an error if any of them does not represent a valid UTF-8
byte sequence. Keys are compared for equality character-by-character,
without considering case folding or normalization. There may be multiple
parameters with equal keys.
- Since
- OOo 2.0
|
Methods' Summary |
getName |
returns the name part of this URL.
|
setName |
sets the name part of this URL.
|
hasParameter |
returns whether this URL has a parameter with a given key.
|
getParameter |
returns the value of a parameter with a given key.
|
setParameter |
sets the value of a parameter with a given key.
|
Methods' Details |
getName
- Description
- returns the name part of this URL.
- Returns
- the non-escaped value of the name part.
|
|
setName
- Description
- sets the name part of this URL.
- Parameter name
- specifies the non-escaped new name part of the URL.
- Throws
- ::com::sun::star::lang::IllegalArgumentException
if name is empty
- Since
- OOo 3.0
|
|
hasParameter
boolean |
hasParameter( |
[in] string |
key ); |
- Description
- returns whether this URL has a parameter with a given key.
- Parameter key
- a non-escaped key.
- Returns
- true if this URL has at least one parameter with the given key. In
particular, if
key is an empty string , false
is returned.
|
|
getParameter
string |
getParameter( |
[in] string |
key ); |
- Description
- returns the value of a parameter with a given key.
- Parameter key
- a non-escaped key.
- Returns
- the non-escaped value of the first parameter with the given key. If
there is no parameter with the given key, or if
key is an
empty string , an empty string is returned.
|
|
setParameter
- Description
- sets the value of a parameter with a given key.
- Parameter key
- a non-escaped key
- Parameter value
- the non-escaped value to be set for the parameter. If there already is a
parameter with this key, the value of its first appearance will be replaced.
Otherwise, a parameter with the given key/value will be appended.
- Throws
- ::com::sun::star::lang::IllegalArgumentException
if key is empty
- Since
- OOo 3.0
|
|
Top of Page
Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.