Package com.smartgwt.client.tools

Class MenuEditProxy

java.lang.Object

com.smartgwt.client.core.BaseClass

com.smartgwt.client.tools.EditProxy

com.smartgwt.client.tools.CanvasEditProxy

com.smartgwt.client.tools.MenuEditProxy

All Implemented Interfaces:

HasHandlers

public class MenuEditProxy
extends CanvasEditProxy

EditProxy that handles MenuButton and MenuBar objects when editMode is enabled.

See Also:

• Dashboards & Tools Framework Overview

Field Summary

Fields inherited from class com.smartgwt.client.core.BaseClass

config, configOnly, factoryCreated, factoryProperties, id, scClassName

Constructor Summary

Constructors

Constructor	Description
MenuEditProxy()
MenuEditProxy(JavaScriptObject jsObj)

Method Summary

Modifier and Type	Method	Description
JavaScriptObject	create()
void	getInlineEditText()	Returns the text based on the current component state to be edited inline.
static MenuEditProxy	getOrCreateRef(JavaScriptObject jsObj)
void	setInlineEditText(String newValue)	Save the new value into the component's state.

Methods inherited from class com.smartgwt.client.tools.EditProxy

getAllowNestedDrops, getAutoMaskChildren, getBringToFrontOnSelect, getCanSelect, getCanSelectChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getEditMask, getHoopSelector, getInlineEditEvent, getInlineEditForm, getInlineEditInstructionLabel, getInlineEditInstructions, getInlineEditMultiline, getInlineEditOnDrop, getJsObj, getOrCreateJsObj, getPersistCoordinates, getSelectedAppearance, getSelectedBorder, getSelectedLabelBackgroundColor, getSelectedTintColor, getSelectedTintOpacity, getShowDragHandle, getSupportsInlineEdit, getUseCopyPasteShortcuts, getUseEditMask, isCreated, setAllowNestedDrops, setAutoMaskChildren, setBringToFrontOnSelect, setCanSelect, setCanSelectChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setInlineEditEvent, setInlineEditInstructions, setInlineEditMultiline, setInlineEditOnDrop, setJavaScriptObject, setPersistCoordinates, setSelectedAppearance, setSelectedBorder, setSelectedLabelBackgroundColor, setSelectedTintColor, setSelectedTintOpacity, setShowDragHandle, setSupportsInlineEdit, setUseCopyPasteShortcuts, setUseEditMask, showSelectedAppearance, startInlineEditing, startInlineEditing

Methods inherited from class com.smartgwt.client.core.BaseClass

addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, asSGWTComponent, clearDynamicProperty, createJsObj, destroy, doAddHandler, doInit, error, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getClassName, getConfig, getHandlerCount, getID, getRef, getRuleScope, getScClassName, getTestInstance, hasAutoAssignedID, hasDynamicProperty, internalSetID, internalSetID, isConfigOnly, isFactoryCreated, onBind, onInit, registerID, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setFactoryCreated, setID, setProperty, setProperty, setProperty, setProperty, setRuleScope, setScClassName

Methods inherited from class java.lang.Object

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

Constructor Details

MenuEditProxy

public MenuEditProxy()

MenuEditProxy

public MenuEditProxy(JavaScriptObject jsObj)

Method Details

getOrCreateRef

public static MenuEditProxy getOrCreateRef(JavaScriptObject jsObj)

create

public JavaScriptObject create()

Overrides:

create in class CanvasEditProxy

getInlineEditText

public void getInlineEditText()

Returns the text based on the current component state to be edited inline. Called by the EditProxy.inlineEditForm to obtain the starting edit value.

Returns the component's menu definition in wiki-style.

Overrides:

getInlineEditText in class EditProxy

setInlineEditText

public void setInlineEditText(String newValue)

Save the new value into the component's state. Called by the EditProxy.inlineEditForm to commit the change.

Updates the component's menu.

Lines starting with "--", "==" or "title:" are considered titles for the MenuButtons. The menuItem definitions follow the title to define the menu contents.

Each menuItem title is entered on its own line. A keyTitle can follow the title separated by a comma. A leading "x" or "o" marks the menuItem as checked. MenuItems can be marked as disabled with a leading or trailing dash (-). A sub-menu is indicated with a trailing >. Any line consisting entirely of one or more dashes (-) or equals (=) indicates a separator line.

Overrides:

setInlineEditText in class EditProxy

Parameters:

newValue - the new component menu