Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

info.magnolia.templating.editor.client
Class PageEditor

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.google.gwt.user.client.ui.LabelBase<String>
              extended by com.google.gwt.user.client.ui.Label
                  extended by com.google.gwt.user.client.ui.HTML
                      extended by info.magnolia.templating.editor.client.PageEditor
All Implemented Interfaces:
com.google.gwt.core.client.EntryPoint, com.google.gwt.editor.client.IsEditor<com.google.gwt.editor.client.LeafValueEditor<String>>, com.google.gwt.event.dom.client.HasAllDragAndDropHandlers, com.google.gwt.event.dom.client.HasAllGestureHandlers, com.google.gwt.event.dom.client.HasAllMouseHandlers, com.google.gwt.event.dom.client.HasAllTouchHandlers, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasDoubleClickHandlers, com.google.gwt.event.dom.client.HasDragEndHandlers, com.google.gwt.event.dom.client.HasDragEnterHandlers, com.google.gwt.event.dom.client.HasDragHandlers, com.google.gwt.event.dom.client.HasDragLeaveHandlers, com.google.gwt.event.dom.client.HasDragOverHandlers, com.google.gwt.event.dom.client.HasDragStartHandlers, com.google.gwt.event.dom.client.HasDropHandlers, com.google.gwt.event.dom.client.HasGestureChangeHandlers, com.google.gwt.event.dom.client.HasGestureEndHandlers, com.google.gwt.event.dom.client.HasGestureStartHandlers, com.google.gwt.event.dom.client.HasMouseDownHandlers, com.google.gwt.event.dom.client.HasMouseMoveHandlers, com.google.gwt.event.dom.client.HasMouseOutHandlers, com.google.gwt.event.dom.client.HasMouseOverHandlers, com.google.gwt.event.dom.client.HasMouseUpHandlers, com.google.gwt.event.dom.client.HasMouseWheelHandlers, com.google.gwt.event.dom.client.HasTouchCancelHandlers, com.google.gwt.event.dom.client.HasTouchEndHandlers, com.google.gwt.event.dom.client.HasTouchMoveHandlers, com.google.gwt.event.dom.client.HasTouchStartHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.i18n.client.HasDirection, com.google.gwt.i18n.shared.HasDirectionEstimator, com.google.gwt.safehtml.client.HasSafeHtml, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasAutoHorizontalAlignment, com.google.gwt.user.client.ui.HasDirectionalHtml, com.google.gwt.user.client.ui.HasDirectionalSafeHtml, com.google.gwt.user.client.ui.HasDirectionalText, com.google.gwt.user.client.ui.HasHorizontalAlignment, com.google.gwt.user.client.ui.HasHTML, com.google.gwt.user.client.ui.HasText, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWordWrap, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.SourcesClickEvents, com.google.gwt.user.client.ui.SourcesMouseEvents
public class PageEditor
extends com.google.gwt.user.client.ui.HTML
implements com.google.gwt.core.client.EntryPoint

Client side implementation of the page editor. Outputs ui widgets inside document element (typically the <html> element). Since the DOM manipulations performed by the PageEditor (i.e. dynamic creation of edit bars) happen when all other javascripts have already been loaded (see GWT bootstrap FAQ), if you have some custom javascript which needs to operate on elements added by the PageEditor, you will have to use the utility javascript method mgnl.PageEditor.onReady(callback). This will ensure that your handler functions are executed when the PageEditor is actually done.

For example: 

 mgnl.PageEditor.onReady( function() {
    alert('hello, page editor is ready.')
 });
Modules can register multiple callbacks this way. The order in which callbacks are fired is the same in which they were registered.

Version:
$Id$ TODO clean up/refactoring.

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
 
Nested classes/interfaces inherited from interface com.google.gwt.i18n.client.HasDirection
com.google.gwt.i18n.client.HasDirection.Direction
 
Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasHorizontalAlignment
com.google.gwt.user.client.ui.HasHorizontalAlignment.AutoHorizontalAlignmentConstant, com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant
 
Field Summary
static ModelStorage model
           
static boolean process
           
 
Fields inherited from class com.google.gwt.user.client.ui.Label
DEFAULT_DIRECTION_ESTIMATOR
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Fields inherited from interface com.google.gwt.user.client.ui.HasAutoHorizontalAlignment
ALIGN_CONTENT_END, ALIGN_CONTENT_START
 
Fields inherited from interface com.google.gwt.user.client.ui.HasHorizontalAlignment
ALIGN_CENTER, ALIGN_DEFAULT, ALIGN_JUSTIFY, ALIGN_LEFT, ALIGN_LOCALE_END, ALIGN_LOCALE_START, ALIGN_RIGHT
 
Constructor Summary
PageEditor()
           
 
Method Summary
static void addComponent(String workspace, String path, String nodeName, String availableComponents)
           
static void createChannelPreview(String channelName, PreviewChannel.Orientation orientation)
           
static void createComponent(String workspace, String path, String itemType)
           
static void deleteComponent(String path)
           
static void enablePreview(boolean preview)
          Enables/disables default (desktop) preview.
static boolean isPreview()
           
 void onModuleLoad()
           
static void openDialog(String dialog, String workspace, String path)
           
static void setPreview(boolean preview)
           
static void showTree(String workspace, String path)
           
 
Methods inherited from class com.google.gwt.user.client.ui.HTML
getHTML, getTextOrHtml, setHTML, setHTML, setHTML, setHTML, wrap
 
Methods inherited from class com.google.gwt.user.client.ui.Label
addClickHandler, addClickListener, addDoubleClickHandler, addDragEndHandler, addDragEnterHandler, addDragHandler, addDragLeaveHandler, addDragOverHandler, addDragStartHandler, addDropHandler, addGestureChangeHandler, addGestureEndHandler, addGestureStartHandler, addMouseDownHandler, addMouseListener, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMouseWheelHandler, addMouseWheelListener, addTouchCancelHandler, addTouchEndHandler, addTouchMoveHandler, addTouchStartHandler, asEditor, getDirection, getText, getTextDirection, removeClickListener, removeMouseListener, removeMouseWheelListener, setDirection, setText, setText
 
Methods inherited from class com.google.gwt.user.client.ui.LabelBase
getAutoHorizontalAlignment, getDirectionEstimator, getHorizontalAlignment, getWordWrap, setAutoHorizontalAlignment, setDirectionEstimator, setDirectionEstimator, setHorizontalAlignment, setWordWrap, updateHorizontalAlignment
 
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, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents
 
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, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.google.gwt.user.client.ui.HasDirectionalText
getTextDirection, setText
 
Methods inherited from interface com.google.gwt.user.client.ui.HasText
getText, setText
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 

Field Detail

model

public static final ModelStorage model

process

public static boolean process
Constructor Detail

PageEditor

public PageEditor()
Method Detail

onModuleLoad

public void onModuleLoad()
Specified by:
onModuleLoad in interface com.google.gwt.core.client.EntryPoint

openDialog

public static void openDialog(String dialog,
                              String workspace,
                              String path)

deleteComponent

public static void deleteComponent(String path)

addComponent

public static void addComponent(String workspace,
                                String path,
                                String nodeName,
                                String availableComponents)

showTree

public static void showTree(String workspace,
                            String path)

createComponent

public static void createComponent(String workspace,
                                   String path,
                                   String itemType)

createChannelPreview

public static void createChannelPreview(String channelName,
                                        PreviewChannel.Orientation orientation)

enablePreview

public static void enablePreview(boolean preview)
Enables/disables default (desktop) preview.

isPreview

public static boolean isPreview()
Returns:
true if the current page is in the default (desktop) preview mode, false otherwise.

setPreview

public static void setPreview(boolean preview)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2003-2013 Magnolia International Ltd.. All Rights Reserved.