com.xpn.xwiki.gwt.api.client.app
Interface XWikiGWTApp

All Known Implementing Classes:

XWikiGWTDefaultApp

public interface XWikiGWTApp

See the NOTICE file distributed with this work for additional information regarding copyright ownership. This is free software;you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation;either version2.1of the License,or(at your option)any later version. This software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this software;if not,write to the Free Software Foundation,Inc.,51 Franklin St,Fifth Floor,Boston,MA 02110-1301 USA,or see the FSF site:http://www.fsf.org.

Author:

ldubost

Method Summary

void	finishLoading() Close the loading dialog when the same amount of call to finishLoading are made than call to startLoading
java.lang.String	getCSSPrefix() Returns the css prefix of the app
java.lang.String	getLocale() Returns the locale of the app
java.lang.String	getName() Returns the name of the app
java.lang.String	getSkinFile(java.lang.String file) Retrieves a url path from the current skin
java.lang.String	getTranslation(java.lang.String key) Provides a translation of a text string
java.lang.String	getTranslation(java.lang.String key, java.lang.String[] args) Provides a translation of a text string
java.lang.String	getTranslationPage() Returns the translation page to load
XWikiServiceAsync	getXWikiServiceInstance() Retrieves an instance of an XWiki Remove Service
boolean	isTranslatorLoaded()
void	showDialog(java.lang.String message)
void	showDialog(java.lang.String title, java.lang.String message)
void	showError(java.lang.String text)
void	showError(java.lang.String code, java.lang.String text)
void	showError(java.lang.Throwable caught)
void	startLoading() Launch the loading dialog.

Method Detail

getName

java.lang.String getName()

Returns the name of the app

getCSSPrefix

java.lang.String getCSSPrefix()

Returns the css prefix of the app

Returns:

getLocale

java.lang.String getLocale()

Returns the locale of the app

Returns:

getTranslationPage

java.lang.String getTranslationPage()

Returns the translation page to load

Returns:

getTranslation

java.lang.String getTranslation(java.lang.String key)

Provides a translation of a text string

Parameters:

key -

Returns:

translated string

getTranslation

java.lang.String getTranslation(java.lang.String key,
                                java.lang.String[] args)

Provides a translation of a text string

Parameters:

key -

args -

Returns:

translated string

getXWikiServiceInstance

XWikiServiceAsync getXWikiServiceInstance()

Retrieves an instance of an XWiki Remove Service

Returns:

getSkinFile

java.lang.String getSkinFile(java.lang.String file)

Retrieves a url path from the current skin

Parameters:

file -

Returns:

A loadable url pointing to the file in the current skin

startLoading

void startLoading()

Launch the loading dialog. Each call to startLoading will add 1 to counter The dialog will be closed only if the same amount of calls to finishLoading is made

finishLoading

void finishLoading()

Close the loading dialog when the same amount of call to finishLoading are made than call to startLoading

showDialog

void showDialog(java.lang.String title,
                java.lang.String message)

Parameters:

title -

message -

showDialog

void showDialog(java.lang.String message)

Parameters:

message -

showError

void showError(java.lang.Throwable caught)

showError

void showError(java.lang.String text)

showError

void showError(java.lang.String code,
               java.lang.String text)

isTranslatorLoaded

boolean isTranslatorLoaded()