goog.editor.Field

Adds an event listener to the event target. The same handler can only be added once per the type. Even if you add the same handler multiple times using the same type then it will only be called once when the event is dispatched.

Registers a keyboard event listener on the field. This is necessary for Gecko since the fields are contained in an iFrame and there is no way to auto-propagate key events up to the main window.

Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added. If a callback is added to an already disposed Disposable, it will be called immediately.

Given the original field element, and the iframe that is destined to become the editable field, styles them appropriately and add the iframe to the dom.

Attach an wrapper to this field, to be thrown out when the field is disposed.

Don't wait for the timer and just fire the delayed change event if it's pending.

Stops all listeners and timers.

Block an event for a short amount of time. Intended for the situation where an event pair fires in quick succession (e.g., mousedown/mouseup, keydown/keyup, focus/blur), and we want the second event in the pair to get "debounced."

WARNING: This should never be used to solve race conditions or for mission-critical actions. It should only be used for UI improvements, where it's okay if the behavior is non-deterministic.

This dispatches the beforechange event on the editable field

Dispatches a blur event.

Dispatches the appropriate set of change events. This only fires synchronous change events in blended-mode, iframe-using mozilla. It just starts the appropriate timer for goog.editor.Field.EventType.DELAYEDCHANGE. This also starts up change events again if they were stopped.

Dispatches a command value change event.

Dispatches an event (or event like object) and calls all listeners listening for events of this type. The type of the event is decided by the type property on the event object.

If any of the listeners returns false OR calls preventDefault then this function will return false. If one of the capture listeners calls stopPropagation, then the bubble listeners won't fire.

Dispatch a selection change event, optionally caused by the given browser event or selecting the given target.

Disposes of the object and its resources.

Removes listeners from this object. Classes that extend EventTarget may need to override this method in order to remove references to DOM Elements and additional listeners.

Executes an editing command as per the registered plugins.

Fires all registered listeners in this listenable for the given type and capture mode, passing them the given eventObject. This does not perform actual capture/bubble. Only implementors of the interface should be using this.

Gives the field focus.

Gives the field focus and places the cursor at the start of the field.

Returns the "application" window, where dialogs and bubbles should be rendered.

Returns the zindex of the base level of the field.

Retrieve the HTML contents of a field.

Do NOT just get the innerHTML of a field directly--there's a lot of processing that needs to happen.

Returns the editable DOM element or null if this field is not editable.

On IE or Safari this is the element with contentEditable=true (in whitebox mode, the iFrame body).

On Gecko this is the iFrame body TODO(user): How do we word this for subclass version?

Get the copy of the editable field element, which has the innerHTML set correctly.

Returns a string usable as a hash code for this field. For field's that were created with an id, the hash code is guaranteed to be the id. TODO(user): I think we can get rid of this. Seems only used from editor.

Returns prepared contents that can be injected into the editable field.

Gets the goog.events.ListenableKey for the event or null if no such listener is in use.

Gets all listeners in this listenable for the given type and capture mode.

Returns original DOM element that is being made editable by Trogedit or null if that element has not yet been found in the appropriate document.

Returns the parent of this event target to use for capture/bubble mechanism.

NOTE(chrishenry): The name reflects the original implementation of custom event target (goog.events.EventTarget). We decided that changing the name is not worth it.

Returns the registered plugin with the given classId.

Handle a change in the Editable Field. Marks the field has modified, dispatches the change event on the editable field (moz only), starts the timer for the delayed change event. Note that these actions only occur if the proper events are not stopped.

Fires a change event only if the attribute change effects the editiable field. We ignore events that are internal browser events (ie scrollbar state change)

Handle the loading of the field (e.g. once the field is ready to setup). TODO(user): this should probably just be moved into dispatchLoadEvent_.

Whether there is any active listeners matching the specified signature. If either the type or capture parameters are unspecified, the function will match on the remaining criteria.

The function to call when the editable iframe loads.

Prepare the given contents, then inject them into the editable field.

Installs styles if needed. Only writes styles when they can't be written inline directly into the field.

Checks if the event of the given type has stopped being dispatched

Checks the modified state of the field. Note: Changes that take place while the goog.editor.Field.EventType.CHANGE event is stopped do not effect the modified state.

Adds an event listener. A listener can only be added once to an object and if it is added again the key for the listener is returned. Note that if the existing listener is a one-off listener (registered via listenOnce), it will no longer be a one-off listener after a call to listen().

Adds an event listener that is removed automatically after the listener fired once.

If an existing listener already exists, listenOnce will do nothing. In particular, if the listener was previously registered via listen(), listenOnce() will not turn the listener into a one-off listener. Similarly, if there is already an existing one-off listener, listenOnce does not modify the listeners (it is still a once listener).

Makes a field editable.

Handles actually making something editable - creating necessary nodes, injecting content, etc.

Closes the field and cancels all pending change timers. Note that this means that if a change event has not fired yet, it will not fire. Clients should check fieldOj.isModified() if they depend on the final change event. Throws an error if the field is already uneditable.

Calls a function to manipulate the dom of this field. This method should be used whenever Trogedit clients need to modify the dom of the field, so that delayed change events are handled appropriately. Extra delayed change events will cause undesired states to be added to the undo-redo stack. This method will always fire at most one delayed change event, depending on the value of opt_preventDelayedChange.

Place the cursor at the start of this field. It's recommended that you only use this method (and manipulate the selection in general) when there is not an existing selection in the field.

Place the cursor at the start of this field. It's recommended that you only use this method (and manipulate the selection in general) when there is not an existing selection in the field.

Gets the value of command(s).

Associates a disposable object with this object so that they will be disposed together.

Registers the plugin with the editable field.

Removes all listeners from this listenable. If type is specified, it will only remove listeners of the particular type. otherwise all registered listeners will be removed.

Removes all wrappers and destroys them.

Removes an event listener from the event target. The handler must be the same object as the one added. If the handler has not been added then nothing is done.

Reset the properties on the original field element to how it was before it was made editable.

Restores the dom to how it was before being made editable.

Restore a saved range, and set the focus on the field. If no range is specified, we simply set the focus.

Sets the application window.

Sets the zIndex that the field should be based off of. TODO(user): Get rid of this completely. Here for Sites. Should this be set directly on UI plugins?

Sets whether activating a hyperlink in this editable field will open a new window or not.

Sets the value that will replace the style attribute of this field's element when the field is made non-editable. This method is called with the current value of the style attribute when the field is made editable.

Sets the parent of this event target to use for capture/bubble mechanism.

Sets the contents of the field.

Sets the target to be used for event.target when firing event. Mainly used for testing. For example, see goog.testing.events.mixinListenable.

Sets flag to control whether to use window mouse up after seeing a mouse down operation on the field.

Sets up the field object and window util of this field, and enables this editable field with all registered plugins. This is essential to the initialization of the field. It must be called when the field becomes fully loaded and editable.

Mutation events tell us when something has changed for mozilla.

Returns true if the field needs to be loaded asynchrnously.

Start change events again and fire once if desired.

Re-starts the event of the given type being dispatched, if it had previously been stopped with stopEvent().

Temporarily ignore change events. If the time has already been set, it will fire immediately now. Further setting of the timer is stopped and dispatching of events is stopped until startChangeEvents is called.

Stops the event of the given type from being dispatched.

Attemps to turn on designMode for a document. This function can fail under certain circumstances related to the load event, and will throw an exception.

Removes an event listener which was added with listen() or listenOnce().

Removes an event listener which was added with listen() by the key returned by listen().

Unregisters the plugin with this field.

Writes the html content into the iframe. Handles writing any aditional styling as well.

If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.

Additional styles to install for the editable field.

Dom helper for the editable node.

No information.

The editable dom node.

The id for this editable field, which must match the id of the element associated with this field.

Logging object.

The dom helper for the node to be made editable.

The original node that is being made editable, or null if it has not yet been found.

Sets the active field id.

Number of milliseconds after a change when the change event should be fired.

Number of milliseconds between delayed change events.

Keycodes that result in a selectionchange event (e.g. the cursor moving).