Java Doc for AdminConsole.java in » Net » openfire » org » jivesoftware » admin » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Net » openfire » org.jivesoftware.admin

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.jivesoftware.admin .AdminConsole

AdminConsole
public class AdminConsole (Code)
	A model for admin tab and sidebar info. This class loads in XML definitions of the data and produces an in-memory model. This class loads its data from the `admin-sidebar.xml` file which is assumed to be in the main application jar file. In addition, it will load files from `META-INF/admin-sidebar.xml` if they're found. This allows developers to extend the functionality of the admin console to provide more options. See the main `admin-sidebar.xml` file for documentation of its format.

Method Summary
public static void	addModel(String name, InputStream in) Adds XML stream to the tabs/sidebar model.
public static void	addModel(String name, Element element) Adds an <adminconsole> Element to the tabs/sidebar model.
public static String	getAdminText(String string, String pluginName) Returns a text element for the admin console, applying the appropriate locale. Internationalization logic will only be applied if the String is specially encoded in the format "${key.name}".
public static synchronized String	getAppName() Returns the name of the application.
public static synchronized Element	getElemnetByID(String id) Convenience method to select an element from the model by its ID.
public static synchronized String	getLoginLogoImage() Returns the URL of the login image for the admin console.
public static synchronized String	getLogoImage() Returns the URL of the main logo image for the admin console.
public static synchronized Element	getModel() Returns the model.
public static synchronized String	getVersionString() Returns the version string displayed in the admin console.
public static void	removeModel(String name) Removes an <adminconsole> Element from the tabs/sidebar model.

Method Detail

addModel
public static void addModel(String name, InputStream in) throws Exception(Code)
	Adds XML stream to the tabs/sidebar model. Parameters: name - the name. Parameters: in - the XML input stream. throws: Exception - if an error occurs when parsing the XML or adding it to the model.

addModel
public static void addModel(String name, Element element) throws Exception(Code)
	Adds an <adminconsole> Element to the tabs/sidebar model. Parameters: name - the name. Parameters: element - the Element throws: Exception - if an error occurs.

getAdminText
public static String getAdminText(String string, String pluginName)(Code)
	Returns a text element for the admin console, applying the appropriate locale. Internationalization logic will only be applied if the String is specially encoded in the format "${key.name}". If it is, the String is pulled from the resource bundle. If the pluginName is not `null`, the plugin's resource bundle will be used to look up the key. Parameters: string - the String. Parameters: pluginName - the name of the plugin that the i18n String can be found in,or `null` if the standard Openfire resource bundle should be used. the string, or if the string is encoded as an i18n key, the value fromthe appropriate resource bundle.

getAppName
public static synchronized String getAppName()(Code)
	Returns the name of the application. the name of the application.

getElemnetByID
public static synchronized Element getElemnetByID(String id)(Code)
	Convenience method to select an element from the model by its ID. If an element with a matching ID is not found, `null` will be returned. Parameters: id - the ID. the element.

getLoginLogoImage
public static synchronized String getLoginLogoImage()(Code)
	Returns the URL of the login image for the admin console. the login image.

getLogoImage
public static synchronized String getLogoImage()(Code)
	Returns the URL of the main logo image for the admin console. the logo image.

getModel
public static synchronized Element getModel()(Code)
	Returns the model. The model should be considered read-only. the model.

getVersionString
public static synchronized String getVersionString()(Code)
	Returns the version string displayed in the admin console. the version string.

removeModel
public static void removeModel(String name)(Code)
	Removes an <adminconsole> Element from the tabs/sidebar model. Parameters: name - the name.

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.