public class PaletteNode extends TreeNode
A PaletteNode
expresses visual properties for how the palette will display it (eg title
, icon
) as
well as instructions for creating the component the paletteNode represents (type
, defaults
).
Various types of palettes (ListPalette
, TreePalette
, MenuPalette
, TilePalette
) render a PaletteNode in different ways, and allow the user to trigger creation
in different ways (eg drag and drop, or just click). All share a common pattern for how components are created from
palettes.
Note that in a TreePalette, a PaletteNode is essentially a TreeNode
and can have properties expected for a TreeNode (eg, showDropIcon
). Likewise a PaletteNode in a
MenuPalette can have the properties of a MenuItem
, such as MenuItem.enableIf()
.
id
factoryCreated, factoryProperties
Constructor and Description |
---|
PaletteNode() |
PaletteNode(com.google.gwt.core.client.JavaScriptObject jsObj) |
Modifier and Type | Method and Description |
---|---|
java.lang.Boolean |
getAlwaysUsePlaceholder()
If set to true, indicates that a Placeholder should always be shown in place of the actual component.
|
java.lang.Boolean |
getCanDuplicate()
If set to false, indicates that this node cannot be
copy & pasted , including disallowing calls to EditContext.makePaletteNode() for EditNodes created from this PaletteNode . |
Canvas |
getCanvasDefaults()
Defaults for the component to be created from this palette.
|
Canvas |
getCanvasLiveObject()
For a paletteNode which should be a "singleton", that is, always provides the exact same object (==) rather than a
dynamically created copy, provide the singleton object as
liveObject . |
DrawItem |
getDrawItemDefaults()
Defaults for the component to be created from this palette.
|
DrawItem |
getDrawItemLiveObject()
For a paletteNode which should be a "singleton", that is, always provides the exact same object (==) rather than a
dynamically created copy, provide the singleton object as
liveObject . |
DrawPane |
getDrawPaneDefaults()
Defaults for the component to be created from this palette.
|
DrawPane |
getDrawPaneLiveObject()
For a paletteNode which should be a "singleton", that is, always provides the exact same object (==) rather than a
dynamically created copy, provide the singleton object as
liveObject . |
EditNode |
getEditNodeProperties()
Properties to be applied to the
editNode when created. |
EditProxy |
getEditProxyProperties()
Properties to be applied to the
liveObject .editProxy when created. |
FormItem |
getFormItemDefaults()
Defaults for the component to be created from this palette.
|
FormItem |
getFormItemLiveObject()
For a paletteNode which should be a "singleton", that is, always provides the exact same object (==) rather than a
dynamically created copy, provide the singleton object as
liveObject . |
java.lang.String |
getIcon()
Icon for this paletteNode.
|
java.lang.String |
getIdName()
Name used to create unique component ID.
|
java.lang.String |
getIdPrefix()
Deprecated.
As of Smart GWT version 12.1, deprecated in favor of
idName |
java.lang.Object |
getLiveObject()
For a paletteNode which should be a "singleton", that is, always provides the exact same
object (==) rather than a dynamically created copy, provide the singleton object as
liveObject . |
static PaletteNode |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.String |
getPlaceholderImage()
Image to display in lieu of the usual placeholder text.
|
Label |
getPlaceholderProperties()
Properties to be applied to the
liveObject when created as a
Placeholder. |
java.lang.Boolean |
getRecreateOnChange()
If set to true, indicates instead of updating the changed property on the target live component a new live component is
created with the current configured properties.
|
java.lang.String |
getRequiredProperties()
Comma separated list of properties for this component that must be provided in
EditNode.defaults before the component will be created. |
java.lang.String |
getTitle()
Textual title for this paletteNode.
|
java.lang.String |
getType()
String this paletteNode creates, for example, "ListGrid".
|
PaletteNode |
setAlwaysUsePlaceholder(java.lang.Boolean alwaysUsePlaceholder)
If set to true, indicates that a Placeholder should always be shown in place of the actual component.
|
PaletteNode |
setCanDuplicate(java.lang.Boolean canDuplicate)
If set to false, indicates that this node cannot be
copy & pasted , including disallowing calls to EditContext.makePaletteNode() for EditNodes created from this PaletteNode . |
PaletteNode |
setCanvasDefaults(Canvas defaults)
Defaults for the component to be created from this palette.
|
PaletteNode |
setCanvasLiveObject(Canvas liveObject)
For a paletteNode which should be a "singleton", that is, always provides the exact same object (==) rather than a
dynamically created copy, provide the singleton object as
liveObject . |
PaletteNode |
setDrawItemDefaults(DrawItem defaults)
Defaults for the component to be created from this palette.
|
PaletteNode |
setDrawItemLiveObject(DrawItem liveObject)
For a paletteNode which should be a "singleton", that is, always provides the exact same object (==) rather than a
dynamically created copy, provide the singleton object as
liveObject . |
PaletteNode |
setDrawPaneDefaults(DrawPane defaults)
Defaults for the component to be created from this palette.
|
PaletteNode |
setDrawPaneLiveObject(DrawPane liveObject)
For a paletteNode which should be a "singleton", that is, always provides the exact same object (==) rather than a
dynamically created copy, provide the singleton object as
liveObject . |
PaletteNode |
setEditNodeProperties(EditNode editNodeProperties)
Properties to be applied to the
editNode when created. |
PaletteNode |
setEditProxyProperties(EditProxy editProxyProperties)
Properties to be applied to the
liveObject .editProxy when created. |
PaletteNode |
setFormItemDefaults(FormItem defaults)
Defaults for the component to be created from this palette.
|
PaletteNode |
setFormItemLiveObject(FormItem liveObject)
For a paletteNode which should be a "singleton", that is, always provides the exact same object (==) rather than a
dynamically created copy, provide the singleton object as
liveObject . |
PaletteNode |
setIcon(java.lang.String icon)
Icon for this paletteNode.
|
PaletteNode |
setIdName(java.lang.String idName)
Name used to create unique component ID.
|
PaletteNode |
setIdPrefix(java.lang.String idPrefix)
Deprecated.
As of Smart GWT version 12.1, deprecated in favor of
idName |
PaletteNode |
setPlaceholderImage(java.lang.String placeholderImage)
Image to display in lieu of the usual placeholder text.
|
PaletteNode |
setPlaceholderProperties(Label placeholderProperties)
Properties to be applied to the
liveObject when created as a
Placeholder. |
PaletteNode |
setRecreateOnChange(java.lang.Boolean recreateOnChange)
If set to true, indicates instead of updating the changed property on the target live component a new live component is
created with the current configured properties.
|
PaletteNode |
setRequiredProperties(java.lang.String requiredProperties)
Comma separated list of properties for this component that must be provided in
EditNode.defaults before the component will be created. |
PaletteNode |
setTitle(java.lang.String title)
Textual title for this paletteNode.
|
PaletteNode |
setType(java.lang.String type)
String this paletteNode creates, for example, "ListGrid".
|
getCanAcceptDrop, getCanDrag, getEnabled, getIconPadding, getName, getShowDropIcon, getShowOpenIcon, getShowSelectedIcon, setCanAcceptDrop, setCanDrag, setChildren, setEnabled, setIconPadding, setID, setIsFolder, setName, setParentID, setShowDropIcon, setShowOpenIcon, setShowSelectedIcon
get_baseStyle, get_canEdit, get_canRemove, getBackgroundComponent, getCanExpand, getCanSelect, getCustomStyle, getDetailDS, getEmbeddedComponent, getEmbeddedComponentFields, getEmbeddedComponentPosition, getIncludeInSummary, getIsGridSummary, getIsGroupSummary, getIsSeparator, getLinkText, getShowRollOver, getSingleCellValue, set_baseStyle, set_canEdit, set_canRemove, setBackgroundComponent, setCanExpand, setCanSelect, setCustomStyle, setDetailDS, setEmbeddedComponent, setEmbeddedComponentFields, setEmbeddedComponentPosition, setIncludeInSummary, setIsGridSummary, setIsGroupSummary, setIsSeparator, setLinkText, setShowRollOver, setSingleCellValue
convertToRecordArray, copyAttributes, copyAttributesInto, getAttributeAsRecordArray, getAttributeAsRecordList, getPaletteDefaults, isARecord, toMap
getRef, getRef, internalSetID
applyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated
public PaletteNode()
public PaletteNode(com.google.gwt.core.client.JavaScriptObject jsObj)
public static PaletteNode getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public PaletteNode setAlwaysUsePlaceholder(java.lang.Boolean alwaysUsePlaceholder)
alwaysUsePlaceholder
- New alwaysUsePlaceholder value. Default value is nullPaletteNode
instance, for chaining setter callspublic java.lang.Boolean getAlwaysUsePlaceholder()
public PaletteNode setCanDuplicate(java.lang.Boolean canDuplicate)
copy & pasted
, including disallowing calls to EditContext.makePaletteNode()
for EditNodes
created from this PaletteNode
.canDuplicate
- New canDuplicate value. Default value is nullPaletteNode
instance, for chaining setter callspublic java.lang.Boolean getCanDuplicate()
copy & pasted
, including disallowing calls to EditContext.makePaletteNode()
for EditNodes
created from this PaletteNode
.public PaletteNode setCanvasDefaults(Canvas defaults)
For example, if type
is "ListGrid", properties valid to pass to ListGrid.create().
Note that event handlers or method overrides cannot be configured as defaults
, as they cannot be serialized
or restored. Instead, create a subclass that implements the desired behaviors, and use that subclass as type
.
See also Reflection
for
special concerns when making a GWT subclass usable in Component XML
and
Dashboards & Tools
in general.
defaults
- New defaults value. Default value is nullPaletteNode
instance, for chaining setter callsSGWTProperties
public Canvas getCanvasDefaults()
For example, if type
is "ListGrid", properties valid to pass to ListGrid.create().
Note that event handlers or method overrides cannot be configured as defaults
, as they cannot be serialized
or restored. Instead, create a subclass that implements the desired behaviors, and use that subclass as type
.
See also Reflection
for
special concerns when making a GWT subclass usable in Component XML
and
Dashboards & Tools
in general.
public PaletteNode setCanvasLiveObject(Canvas liveObject)
liveObject
. Instead of dynamically creating
an object from defaults, the liveObject
will simply be assigned to EditNode.liveObject
for the created editNode.
liveObject
- New liveObject value. Default value is nullPaletteNode
instance, for chaining setter callspublic Canvas getCanvasLiveObject()
liveObject
. Instead of dynamically creating
an object from defaults, the liveObject
will simply be assigned to EditNode.liveObject
for the created editNode.
public PaletteNode setDrawItemDefaults(DrawItem defaults)
For example, if type
is "ListGrid", properties valid to pass to ListGrid.create().
Note that event handlers or method overrides cannot be configured as defaults
, as they cannot be serialized
or restored. Instead, create a subclass that implements the desired behaviors, and use that subclass as type
.
See also Reflection
for
special concerns when making a GWT subclass usable in Component XML
and
Dashboards & Tools
in general.
defaults
- New defaults value. Default value is nullPaletteNode
instance, for chaining setter callsSGWTProperties
public DrawItem getDrawItemDefaults()
For example, if type
is "ListGrid", properties valid to pass to ListGrid.create().
Note that event handlers or method overrides cannot be configured as defaults
, as they cannot be serialized
or restored. Instead, create a subclass that implements the desired behaviors, and use that subclass as type
.
See also Reflection
for
special concerns when making a GWT subclass usable in Component XML
and
Dashboards & Tools
in general.
public PaletteNode setDrawItemLiveObject(DrawItem liveObject)
liveObject
. Instead of dynamically creating
an object from defaults, the liveObject
will simply be assigned to EditNode.liveObject
for the created editNode.
liveObject
- New liveObject value. Default value is nullPaletteNode
instance, for chaining setter callspublic DrawItem getDrawItemLiveObject()
liveObject
. Instead of dynamically creating
an object from defaults, the liveObject
will simply be assigned to EditNode.liveObject
for the created editNode.
public PaletteNode setDrawPaneDefaults(DrawPane defaults)
For example, if type
is "ListGrid", properties valid to pass to ListGrid.create().
Note that event handlers or method overrides cannot be configured as defaults
, as they cannot be serialized
or restored. Instead, create a subclass that implements the desired behaviors, and use that subclass as type
.
See also Reflection
for
special concerns when making a GWT subclass usable in Component XML
and
Dashboards & Tools
in general.
defaults
- New defaults value. Default value is nullPaletteNode
instance, for chaining setter callsSGWTProperties
public DrawPane getDrawPaneDefaults()
For example, if type
is "ListGrid", properties valid to pass to ListGrid.create().
Note that event handlers or method overrides cannot be configured as defaults
, as they cannot be serialized
or restored. Instead, create a subclass that implements the desired behaviors, and use that subclass as type
.
See also Reflection
for
special concerns when making a GWT subclass usable in Component XML
and
Dashboards & Tools
in general.
public PaletteNode setDrawPaneLiveObject(DrawPane liveObject)
liveObject
. Instead of dynamically creating
an object from defaults, the liveObject
will simply be assigned to EditNode.liveObject
for the created editNode.
liveObject
- New liveObject value. Default value is nullPaletteNode
instance, for chaining setter callspublic DrawPane getDrawPaneLiveObject()
liveObject
. Instead of dynamically creating
an object from defaults, the liveObject
will simply be assigned to EditNode.liveObject
for the created editNode.
public PaletteNode setEditNodeProperties(EditNode editNodeProperties)
editNode
when created.editNodeProperties
- New editNodeProperties value. Default value is nullPaletteNode
instance, for chaining setter callspublic EditNode getEditNodeProperties()
editNode
when created.public PaletteNode setEditProxyProperties(EditProxy editProxyProperties)
liveObject
.editProxy
when created.editProxyProperties
- New editProxyProperties value. Default value is nullPaletteNode
instance, for chaining setter callsSGWTProperties
public EditProxy getEditProxyProperties()
liveObject
.editProxy
when created.public PaletteNode setFormItemDefaults(FormItem defaults)
For example, if type
is "ListGrid", properties valid to pass to ListGrid.create().
Note that event handlers or method overrides cannot be configured as defaults
, as they cannot be serialized
or restored. Instead, create a subclass that implements the desired behaviors, and use that subclass as type
.
See also Reflection
for
special concerns when making a GWT subclass usable in Component XML
and
Dashboards & Tools
in general.
defaults
- New defaults value. Default value is nullPaletteNode
instance, for chaining setter callspublic FormItem getFormItemDefaults()
For example, if type
is "ListGrid", properties valid to pass to ListGrid.create().
Note that event handlers or method overrides cannot be configured as defaults
, as they cannot be serialized
or restored. Instead, create a subclass that implements the desired behaviors, and use that subclass as type
.
See also Reflection
for
special concerns when making a GWT subclass usable in Component XML
and
Dashboards & Tools
in general.
public PaletteNode setFormItemLiveObject(FormItem liveObject)
liveObject
. Instead of dynamically creating
an object from defaults, the liveObject
will simply be assigned to EditNode.liveObject
for the created editNode.
liveObject
- New liveObject value. Default value is nullPaletteNode
instance, for chaining setter callspublic FormItem getFormItemLiveObject()
liveObject
. Instead of dynamically creating
an object from defaults, the liveObject
will simply be assigned to EditNode.liveObject
for the created editNode.
public PaletteNode setIcon(java.lang.String icon)
setIcon
in class TreeNode
icon
- New icon value. Default value is nullPaletteNode
instance, for chaining setter callsSCImgURL
public java.lang.String getIcon()
public PaletteNode setIdName(java.lang.String idName)
type
is
used. Note: idName must follow all rules for a Identifier
.
idName
- New idName value. Default value is nullPaletteNode
instance, for chaining setter callspublic java.lang.String getIdName()
type
is
used. Note: idName must follow all rules for a Identifier
.
public PaletteNode setIdPrefix(java.lang.String idPrefix)
idName
type
is used.idPrefix
- New idPrefix value. Default value is nullPaletteNode
instance, for chaining setter callspublic java.lang.String getIdPrefix()
idName
type
is used.public PaletteNode setPlaceholderImage(java.lang.String placeholderImage)
placeholderImage
- New placeholderImage value. Default value is nullPaletteNode
instance, for chaining setter callsSCImgURL
public java.lang.String getPlaceholderImage()
SCImgURL
public PaletteNode setPlaceholderProperties(Label placeholderProperties)
liveObject
when created as a
Placeholder.placeholderProperties
- New placeholderProperties value. Default value is nullPaletteNode
instance, for chaining setter callsSGWTProperties
public Label getPlaceholderProperties()
liveObject
when created as a
Placeholder.public PaletteNode setRecreateOnChange(java.lang.Boolean recreateOnChange)
This property is typically set when a custom component is being used that doesn't support setters for any or most of its properties and a change can be reflected by recreating the component.
Individual properties of the target component can be marked similarly on the component's schema for more
fine-grained control. See DataSourceField.recreateOnChange
.
recreateOnChange
- New recreateOnChange value. Default value is nullPaletteNode
instance, for chaining setter callspublic java.lang.Boolean getRecreateOnChange()
This property is typically set when a custom component is being used that doesn't support setters for any or most of its properties and a change can be reflected by recreating the component.
Individual properties of the target component can be marked similarly on the component's schema for more
fine-grained control. See DataSourceField.recreateOnChange
.
public PaletteNode setRequiredProperties(java.lang.String requiredProperties)
EditNode.defaults
before the component will be created. Otherwise a
Placeholder will be used until the required properties are satisfied.requiredProperties
- New requiredProperties value. Default value is nullPaletteNode
instance, for chaining setter callspublic java.lang.String getRequiredProperties()
EditNode.defaults
before the component will be created. Otherwise a
Placeholder will be used until the required properties are satisfied.public PaletteNode setTitle(java.lang.String title)
setTitle
in class TreeNode
title
- New title value. Default value is nullPaletteNode
instance, for chaining setter callsTree.setTitleProperty(java.lang.String)
,
Tree.getTitle(com.smartgwt.client.widgets.tree.TreeNode)
,
HTMLString
public java.lang.String getTitle()
getTitle
in class TreeNode
Tree.getTitleProperty()
,
Tree.getTitle(com.smartgwt.client.widgets.tree.TreeNode)
,
HTMLString
public PaletteNode setType(java.lang.String type)
type
- New type value. Default value is nullPaletteNode
instance, for chaining setter callsSCClassName
public java.lang.String getType()
SCClassName
public java.lang.Object getLiveObject()
liveObject
.
Instead of dynamically creating an object from defaults, the liveObject
will
simply be assigned to
EditNode.liveObject
for the
created editNode.
Use the more specific live object getter API, such as
getCanvasLiveObject()
if you are sure of the type.
getCanvasLiveObject()
,
getDrawItemLiveObject()
,
getDrawPaneLiveObject()
,
getFormItemLiveObject()