org.xwiki.gwt.wysiwyg.client.widget.explorer

Class XWikiExplorer

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

org.xwiki.gwt.wysiwyg.client.widget.explorer.XWikiExplorer

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget, HasDoubleClickNodeHandlers

public class XWikiExplorer
extends com.google.gwt.user.client.ui.Widget
implements HasDoubleClickNodeHandlers

Wrapper for XWikiExplorer SmartClient-based widget.

Version:

$Id: 550c6ca009adffb8c075b3fb923b206c0af4ed58 $

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
XWikiExplorer(String url) Creates a new document tree widget.

Method Summary

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	addDoubleClickNodeHandler(DoubleClickNodeHandler handler) Registers the given handles for double click node events.
String	getSelectedAttachment() Get the name of the attachment selected in the Tree.
String	getSelectedPage() Get the name of the page selected in the Tree.
String	getSelectedSpace() Get the name of the space selected in the Tree.
String	getSelectedWiki() Get the name of the wiki selected in the Tree.
boolean	hasSelectedNode()
void	invalidateCache() Reload the tree content next time it is displayed again.
boolean	isNewAttachment() Is the selected resource a new attachment.
boolean	isNewPage() Is the selected resource a new page.
protected void	onLoad()
protected void	onUnload()
void	selectEntity(EntityReference entityReference, String anchor) Selects the tree node corresponding to the specified entity and anchor.

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

XWikiExplorer

public XWikiExplorer(String url)

Creates a new document tree widget.

Parameters:

url - the URL of the resource that represents the tree

Method Detail

onLoad

protected void onLoad()

Overrides:

onLoad in class com.google.gwt.user.client.ui.Widget

onUnload

protected void onUnload()

Overrides:

onUnload in class com.google.gwt.user.client.ui.Widget

getSelectedWiki

public String getSelectedWiki()

Get the name of the wiki selected in the Tree.

Returns:

the name of the wiki selected in the Tree, empty string if none selected.

getSelectedSpace

public String getSelectedSpace()

Get the name of the space selected in the Tree.

Returns:

the name of the space selected in the Tree, empty string if none selected.

getSelectedPage

public String getSelectedPage()

Get the name of the page selected in the Tree.

Returns:

the name of the page selected in the Tree, empty string if none selected.

getSelectedAttachment

public String getSelectedAttachment()

Get the name of the attachment selected in the Tree.

Returns:

the name of the attachment selected in the Tree, empty string if none selected.

isNewPage

public boolean isNewPage()

Is the selected resource a new page.

Returns:

true if the selected node is a new page.

isNewAttachment

public boolean isNewAttachment()

Is the selected resource a new attachment.

Returns:

true if the selected node is a new Attachment.

selectEntity

public void selectEntity(EntityReference entityReference,
                         String anchor)

Selects the tree node corresponding to the specified entity and anchor.

Parameters:

entityReference - an entity reference

anchor - a string identifying a fragment of the specified entity

hasSelectedNode

public boolean hasSelectedNode()

Returns:

true if a node is selected in the tree, false otherwise

addDoubleClickNodeHandler

public com.google.gwt.event.shared.HandlerRegistration addDoubleClickNodeHandler(DoubleClickNodeHandler handler)

Description copied from interface: HasDoubleClickNodeHandlers

Registers the given handles for double click node events.

Specified by:

addDoubleClickNodeHandler in interface HasDoubleClickNodeHandlers

Parameters:

handler - the object to be notified when a node is double clicked

Returns:

the registration for the event, to be used for removing the handler

invalidateCache

public void invalidateCache()

Reload the tree content next time it is displayed again. Call this method whenever new data is added to the tree (e.g. new attachment, new page).