Package org.opencms.acacia.client.widgets.code

Class CmsCodeMirrorWidget

java.lang.Object
com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.google.gwt.user.client.ui.Panel
com.google.gwt.user.client.ui.ComplexPanel
org.opencms.acacia.client.widgets.code.CmsCodeMirrorWidget
All Implemented Interfaces:
com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasResizeHandlers, com.google.gwt.event.logical.shared.HasValueChangeHandlers<String>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.TakesValue<String>, com.google.gwt.user.client.ui.HasValue<String>, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, Iterable<com.google.gwt.user.client.ui.Widget>, I_CmsEditWidget
public class CmsCodeMirrorWidget extends com.google.gwt.user.client.ui.ComplexPanel implements I_CmsEditWidget, com.google.gwt.event.logical.shared.HasResizeHandlers
Client-side content editor widget for editing source code using the CodeMirror library.

  • 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.user.client.ui.HasWidgets

    com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

    Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel

    com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

  • Field Summary

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

    DEBUG_ID_PREFIX

  • Constructor Summary

    Constructors
    Constructor
    Description
    CmsCodeMirrorWidget(String config)
    Creates a new display widget.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.gwt.event.shared.HandlerRegistration
    addFocusHandler(com.google.gwt.event.dom.client.FocusHandler handler)
     
    com.google.gwt.event.shared.HandlerRegistration
    addResizeHandler(com.google.gwt.event.logical.shared.ResizeHandler handler)
     
    com.google.gwt.event.shared.HandlerRegistration
    addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<String> handler)
     
    void
    fireChangeEvent()
    Represents a value change event.
    void
    fireResizeeEvent(com.google.gwt.event.logical.shared.ResizeEvent event)
    Represents a resize event.
    protected void
    fireValueChange(boolean force)
    Fires the value change event, if the value has changed.
    String
    getEffectiveMode()
    Gets the effective mode to use, which depends both on the selected mode and on whether the user has enabled syntax highlighting.
    protected String
    getPreviousValue()
    Returns the previous value.
    String
    getValue()
     
    boolean
    isActive()
    Returns if the widget is active.
    protected void
    onAttach()
     
    void
    onAttachWidget()
    This method is called when a widget is attached to the browser's document.
    boolean
    owns(com.google.gwt.dom.client.Element element)
    Returns true if the element should be logically counted as part of the widget for the purpose of determining whether a mouse click is "outside".
    void
    setActive(boolean active)
    Sets the widget active/inactive.
    void
    setName(String name)
    Sets the name of input fields.
    protected void
    setPreviousValue(String previousValue)
    Sets the previous value.
    void
    setValue(String value)
     
    void
    setValue(String value, boolean fireEvents)
     

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

    add, add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove, remove

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

    add, add, adopt, clear, doAttachChildren, doDetachChildren, orphan, remove

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

    addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onDetach, onLoad, onUnload, 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

    Methods inherited from interface org.opencms.acacia.client.widgets.I_CmsEditWidget

    shouldSetDefaultWhenDisabled

    Methods inherited from interface com.google.gwt.user.client.ui.IsWidget

    asWidget

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

  • Constructor Details

    • CmsCodeMirrorWidget

      public CmsCodeMirrorWidget(String config)
      Creates a new display widget.

      Parameters:
      config - the widget configuration string

  • Method Details

    • addFocusHandler

      public com.google.gwt.event.shared.HandlerRegistration addFocusHandler(com.google.gwt.event.dom.client.FocusHandler handler)
      Specified by:
      addFocusHandler in interface com.google.gwt.event.dom.client.HasFocusHandlers
      See Also:
      • HasFocusHandlers.addFocusHandler(com.google.gwt.event.dom.client.FocusHandler)

    • addResizeHandler

      public com.google.gwt.event.shared.HandlerRegistration addResizeHandler(com.google.gwt.event.logical.shared.ResizeHandler handler)
      Specified by:
      addResizeHandler in interface com.google.gwt.event.logical.shared.HasResizeHandlers
      See Also:
      • HasResizeHandlers.addResizeHandler(com.google.gwt.event.logical.shared.ResizeHandler)

    • addValueChangeHandler

      public com.google.gwt.event.shared.HandlerRegistration addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<String> handler)
      Specified by:
      addValueChangeHandler in interface com.google.gwt.event.logical.shared.HasValueChangeHandlers<String>
      Specified by:
      addValueChangeHandler in interface I_CmsEditWidget
      See Also:
      • HasValueChangeHandlers.addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler)

    • fireChangeEvent

      public void fireChangeEvent()
      Represents a value change event.

    • fireResizeeEvent

      public void fireResizeeEvent(com.google.gwt.event.logical.shared.ResizeEvent event)
      Represents a resize event.

      Parameters:
      event - from text area panel

    • getEffectiveMode

      public String getEffectiveMode()
      Gets the effective mode to use, which depends both on the selected mode and on whether the user has enabled syntax highlighting.
      Returns:
      the effective mode

    • getValue

      public String getValue()
      Specified by:
      getValue in interface com.google.gwt.user.client.ui.HasValue<String>
      Specified by:
      getValue in interface com.google.gwt.user.client.TakesValue<String>
      See Also:
      • HasValue.getValue()

    • isActive

      public boolean isActive()
      Description copied from interface: I_CmsEditWidget
      Returns if the widget is active.

      Specified by:
      isActive in interface I_CmsEditWidget
      Returns:
      true if the widget is active
      See Also:

    • onAttachWidget

      public void onAttachWidget()
      Description copied from interface: I_CmsEditWidget
      This method is called when a widget is attached to the browser's document.

      It needs to call the Widget.onAttach() method.

      Specified by:
      onAttachWidget in interface I_CmsEditWidget
      See Also:

    • owns

      public boolean owns(com.google.gwt.dom.client.Element element)
      Description copied from interface: I_CmsEditWidget
      Returns true if the element should be logically counted as part of the widget for the purpose of determining whether a mouse click is "outside". For example, this is needed if the widget uses a popup.
      Specified by:
      owns in interface I_CmsEditWidget
      Parameters:
      element - the element to check
      Returns:
      true if the element counts as part of the widget
      See Also:

    • setActive

      public void setActive(boolean active)
      Description copied from interface: I_CmsEditWidget
      Sets the widget active/inactive.

      Specified by:
      setActive in interface I_CmsEditWidget
      Parameters:
      active - true to activate the widget
      See Also:

    • setName

      public void setName(String name)
      Description copied from interface: I_CmsEditWidget
      Sets the name of input fields.

      Specified by:
      setName in interface I_CmsEditWidget
      Parameters:
      name - of the input field
      See Also:

    • setValue

      public void setValue(String value)
      Specified by:
      setValue in interface com.google.gwt.user.client.ui.HasValue<String>
      Specified by:
      setValue in interface com.google.gwt.user.client.TakesValue<String>
      See Also:
      • HasValue.setValue(java.lang.Object)

    • setValue

      public void setValue(String value, boolean fireEvents)
      Specified by:
      setValue in interface com.google.gwt.user.client.ui.HasValue<String>
      Specified by:
      setValue in interface I_CmsEditWidget
      See Also:
      • HasValue.setValue(java.lang.Object, boolean)

    • fireValueChange

      protected void fireValueChange(boolean force)
      Fires the value change event, if the value has changed.

      Parameters:
      force - true to force firing the event, not regarding an actually changed value

    • getPreviousValue

      protected String getPreviousValue()
      Returns the previous value.

      Returns:
      the previous value

    • onAttach

      protected void onAttach()
      Overrides:
      onAttach in class com.google.gwt.user.client.ui.Widget
      See Also:
      • FocusWidget.onAttach()

    • setPreviousValue

      protected void setPreviousValue(String previousValue)
      Sets the previous value.

      Parameters:
      previousValue - the previous value to set