PollwikiG (Votorola Java API)

java.lang.Object
- PollwikiG

All Implemented Interfaces:

Pollwiki
```
public final class PollwikiG
extends Object
implements Pollwiki
```
A pollwiki from the viewpoint of a GWT client.

See Also:
App.pollwiki()

Constructor Summary

Constructors
Constructor and Description

PollwikiG()

Constructors
Constructor and Description
`PollwikiG()`

Method Summary

Methods
Modifier and Type	Method and Description
`StringBuilder`	`appendPageSpecifier(String encodedPageName)` Appends an already encoded page name to the wiki base URL.
`StringBuilder`	`encodePageSpecifier(String pageName)` Encodes a page name and appends it to the wiki base URL.
`(package private) static void`	`forceInitClass()` Does nothing itself but the call forces static initialization of this class.
`static String`	`getLocation()` The base URL for requesting pages from the pollwiki, without a trailing slash (/).
`static String`	`getScriptLocation()` The base URL for script execution in the pollwiki, without a trailing slash (/).
`PositionID`	`identifyAsPosition(Document page)` Returns the position identifier of the loaded page, or null if the page is not a position page.
`PositionID`	`identifyAsPosition(String pageName)` Returns the position identifier of the loaded page, or null if the page is not a position page.
`boolean`	`maybeUgly()` Answers whether the wiki URL might be based on the standard access URL ending in "index.php" for example, or is definitely based on a pretty alias per `$wgUsePathInfo`.
`PipeRecognizer`	`pipeRecognizer()` A recognizer of pipes in the pollwiki.
`String`	`positionPageName(String personName, String pollName)` Returns the page name of the specified position.
`static void`	`setLocation(String s)` Sets the base URL for requesting pages from the pollwiki.
`static void`	`setPipeRecognizer(String pipePrefix, String pipeSuffix)` Configures the pipe recognizer.
`static void`	`setScriptLocation(String s)` Sets base URL for for script execution in the pollwiki.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PollwikiG
```
public PollwikiG()
```
- Method Detail
  - forceInitClass
```
static void forceInitClass()
```
    Does nothing itself but the call forces static initialization of this class.
  - encodePageSpecifier
```
public StringBuilder encodePageSpecifier(String pageName)
```
    Encodes a page name and appends it to the wiki base URL. Usage example:
```
     String href = voteServer.pollwiki().encodePageSpecifier(
       "Main page" ).build().toASCIIString();
```
    See Also:
    appendPageSpecifier(String)
  - getLocation
```
@GWTConfigCallback
public static String getLocation()
```
    The base URL for requesting pages from the pollwiki, without a trailing slash (/). This is either the standard access URL ending in "index.php" for example, or a pretty alias per $wgUsePathInfo.
    
    See Also:
    appendPageSpecifier(String), maybeUgly(), setLocation(String)
  - setLocation
```
@GWTConfigCallback
public static void setLocation(String s)
```
    Sets the base URL for requesting pages from the pollwiki. Call it from the global configuration function voGWTConfig.a in this manner:
```
   a_web_gwt_PollwikiG_setLocation( 'http://YOUR.DOM/wiki' );
     // defaults to http://SCRIPT-LOCATION/index.php
```
    Throws:
    
    IllegalArgumentException - if the location ends with a slash '/' character.
    See Also:
    getLocation(), setScriptLocation(String)
  - getScriptLocation
```
@GWTConfigCallback
public static String getScriptLocation()
```
    The base URL for script execution in the pollwiki, without a trailing slash (/). For example http://reluk.ca/mediawiki. Script requests may be constructed by appending the script path and parameters:
```
    getScriptLocation() + "/index.php?oldid=1138"
```
    See Also:
    setScriptLocation(String)
  - setScriptLocation
```
@GWTConfigCallback
public static void setScriptLocation(String s)
```
    Sets base URL for for script execution in the pollwiki. Call it from the global configuration function voGWTConfig.a in this manner:
```
   a_web_gwt_PollwikiG_setScriptLocation( 'http://YOUR.DOM/mediawiki' );
     // defaults to the standard location http://SERVER.DOM/mediawiki
     // where SERVER.DOM is a calculated guess at the web server name
```
    Throws:
    
    IllegalArgumentException - if the location ends with a slash '/' character.
    See Also:
    getScriptLocation()
  - identifyAsPosition
```
public PositionID identifyAsPosition(Document page)
```
    Returns the position identifier of the loaded page, or null if the page is not a position page.
  - identifyAsPosition
```
public PositionID identifyAsPosition(String pageName)
```
    Returns the position identifier of the loaded page, or null if the page is not a position page.
  - appendPageSpecifier
```
public StringBuilder appendPageSpecifier(String encodedPageName)
```
    Description copied from interface: Pollwiki
    Appends an already encoded page name to the wiki base URL. Usage example:
```
     String href = pollwiki.appendPageSpecifier( "Main_page" ).toString();
```
    Specified by:
    
    appendPageSpecifier in interface Pollwiki
    
    See Also:
    getLocation(), encodePageSpecifier(String)
  - maybeUgly
```
public boolean maybeUgly()
```
    Description copied from interface: Pollwiki
    
    Answers whether the wiki URL might be based on the standard access URL ending in "index.php" for example, or is definitely based on a pretty alias per $wgUsePathInfo.
    
    Specified by:
    
    maybeUgly in interface Pollwiki
    
    See Also:
    getLocation()
  - pipeRecognizer
```
public PipeRecognizer pipeRecognizer()
```
    Description copied from interface: Pollwiki
    
    A recognizer of pipes in the pollwiki.
    
    Specified by:
    
    pipeRecognizer in interface Pollwiki
    
    See Also:
    setPipeRecognizer(String,String)
  - setPipeRecognizer
```
@GWTConfigCallback
public static void setPipeRecognizer(String pipePrefix,
                                       String pipeSuffix)
```
    Configures the pipe recognizer. Call this method from the global configuration function voGWTConfig.a in this manner:
```
   a_web_gwt_PollwikiG_setPipeRecognizer( 'PREFIX', 'SUFFIX' );
     // there are no dependable defaults, you should set values if pipes are enabled
```
    See Also:
    pipeRecognizer(), Category:Pipe#Enabling pipes in the wiki
  - positionPageName
```
public String positionPageName(String personName,
                      String pollName)
```
    Description copied from interface: Pollwiki
    
    Returns the page name of the specified position.
    
    Specified by:
    
    positionPageName in interface Pollwiki
    
    pollName - this parameter is ignored if the named person is actually a pipe.
    See Also:
    PositionID.pageName(String,String,PipeRecognizer), Category:Position

Class PollwikiG

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PollwikiG

Method Detail

forceInitClass

encodePageSpecifier

getLocation

setLocation

getScriptLocation

setScriptLocation

identifyAsPosition

identifyAsPosition

appendPageSpecifier

maybeUgly

pipeRecognizer

setPipeRecognizer

positionPageName