Class NavItem
- All Implemented Interfaces:
HasHandlers
Properties for a navigation item in a
NavPanel.-
Field Summary
Fields inherited from class com.smartgwt.client.core.RefDataClass
idFields inherited from class com.smartgwt.client.core.DataClass
factoryCreated, factoryProperties -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionCSS style name used for thisNavItem.Criteria to be evaluated to determine whether this NavItem should be disabled.getIcon()Icon to show for thisNavItem.getId()An optional ID for thisNavItem.If set, thisNavItemwill be styled like a header.If set, thisNavItemwill be styled as a separator.NavItem[]getItems()Optional subitems of thisNavItem.static NavItemgetOrCreateRef(JavaScriptObject jsObj) getPane()Component to display in theNavPanel.navDeckwhen thisNavItemis selected.Component to display in theNavPanel.navDeckwhen thisNavItemis selected.getTitle()Title to show for thisNavItem.setCustomStyle(String customStyle) CSS style name used for thisNavItem.setEnableWhen(AdvancedCriteria enableWhen) Criteria to be evaluated to determine whether this NavItem should be disabled.Icon to show for thisNavItem.An optional ID for thisNavItem.setIsHeader(Boolean isHeader) If set, thisNavItemwill be styled like a header.setIsSeparator(Boolean isSeparator) If set, thisNavItemwill be styled as a separator.Optional subitems of thisNavItem.Component to display in theNavPanel.navDeckwhen thisNavItemis selected.Component to display in theNavPanel.navDeckwhen thisNavItemis selected.Title to show for thisNavItem.Methods inherited from class com.smartgwt.client.widgets.tree.TreeNode
getCanAcceptDrop, getCanDrag, getEnabled, getIconPadding, getName, getShowDropIcon, getShowOpenIcon, getShowSelectedIcon, setCanAcceptDrop, setCanDrag, setChildren, setEnabled, setIconPadding, setID, setIsFolder, setName, setParentID, setShowDropIcon, setShowOpenIcon, setShowSelectedIconMethods inherited from class com.smartgwt.client.widgets.grid.ListGridRecord
get_baseStyle, get_canEdit, get_canRemove, getBackgroundComponent, getCanExpand, getCanSelect, getDetailDS, getEmbeddedComponent, getEmbeddedComponentFields, getEmbeddedComponentPosition, getIncludeInSummary, getIsGridSummary, getIsGroupSummary, getLinkText, getShowRollOver, getSingleCellValue, set_baseStyle, set_canEdit, set_canRemove, setBackgroundComponent, setCanExpand, setCanSelect, setDetailDS, setEmbeddedComponent, setEmbeddedComponentFields, setEmbeddedComponentPosition, setIncludeInSummary, setIsGridSummary, setIsGroupSummary, setLinkText, setShowRollOver, setSingleCellValueMethods inherited from class com.smartgwt.client.data.Record
convertToRecordArray, copyAttributes, copyAttributesInto, getAttributeAsRecordArray, getAttributeAsRecordList, getPaletteDefaults, isARecord, toMapMethods inherited from class com.smartgwt.client.core.RefDataClass
getRef, getRef, internalSetIDMethods inherited from class com.smartgwt.client.core.DataClass
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
-
Constructor Details
-
NavItem
public NavItem() -
NavItem
-
-
Method Details
-
getOrCreateRef
-
setCustomStyle
CSS style name used for thisNavItem. If set and thisNavItemis aheader, this overrides theNavPanel'sNavPanel.headerStyle.- Overrides:
setCustomStylein classListGridRecord- Parameters:
customStyle- New customStyle value. Default value is null- Returns:
NavIteminstance, for chaining setter calls- See Also:
-
getCustomStyle
CSS style name used for thisNavItem. If set and thisNavItemis aheader, this overrides theNavPanel'sNavPanel.headerStyle.- Overrides:
getCustomStylein classListGridRecord- Returns:
- Current customStyle value. Default value is null
- See Also:
-
setEnableWhen
Criteria to be evaluated to determine whether this NavItem should be disabled.A basic criteria uses textMatchStyle:"exact". When specified in
Component XMLthis property allowsshorthand formatsfor defining criteria.- Parameters:
enableWhen- New enableWhen value. Default value is null- Returns:
NavIteminstance, for chaining setter calls- See Also:
-
getEnableWhen
Criteria to be evaluated to determine whether this NavItem should be disabled.A basic criteria uses textMatchStyle:"exact". When specified in
Component XMLthis property allowsshorthand formatsfor defining criteria.- Returns:
- Current enableWhen value. Default value is null
- See Also:
-
setIcon
Icon to show for thisNavItem. If not specified, thenavGrid's folderIconis used. -
getIcon
Icon to show for thisNavItem. If not specified, thenavGrid's folderIconis used. -
setId
An optional ID for thisNavItem. If specified, this must be unique within theNavPanel.- Parameters:
id- New id value. Default value is null- Returns:
NavIteminstance, for chaining setter calls- See Also:
-
getId
An optional ID for thisNavItem. If specified, this must be unique within theNavPanel.- Returns:
- Current id value. Default value is null
- See Also:
-
setIsHeader
If set, thisNavItemwill be styled like a header. In this casepaneis ignored and nothing happens when the header is clicked. However,itemscan still be configured to place items hierarchically under the header.- Parameters:
isHeader- New isHeader value. Default value is null- Returns:
NavIteminstance, for chaining setter calls
-
getIsHeader
If set, thisNavItemwill be styled like a header. In this casepaneis ignored and nothing happens when the header is clicked. However,itemscan still be configured to place items hierarchically under the header.- Returns:
- Current isHeader value. Default value is null
-
setIsSeparator
If set, thisNavItemwill be styled as a separator. A separator does not have apaneand nothing happens when the separator is clicked.- Overrides:
setIsSeparatorin classListGridRecord- Parameters:
isSeparator- New isSeparator value. Default value is null- Returns:
NavIteminstance, for chaining setter calls
-
getIsSeparator
If set, thisNavItemwill be styled as a separator. A separator does not have apaneand nothing happens when the separator is clicked.- Overrides:
getIsSeparatorin classListGridRecord- Returns:
- Current isSeparator value. Default value is null
-
getItems
Optional subitems of thisNavItem.- Returns:
- Current items value. Default value is null
-
setPane
Component to display in theNavPanel.navDeckwhen thisNavItemis selected.A component can be provided directly, or its ID can be provided.
- Parameters:
pane- New pane value. Default value is null- Returns:
NavIteminstance, for chaining setter calls
-
getPane
Component to display in theNavPanel.navDeckwhen thisNavItemis selected.A component can be provided directly, or its ID can be provided.
- Returns:
- Current pane value. Default value is null
-
setPane
Component to display in theNavPanel.navDeckwhen thisNavItemis selected.A component can be provided directly, or its ID can be provided.
- Parameters:
pane- New pane value. Default value is null- Returns:
NavIteminstance, for chaining setter calls- See Also:
-
getPaneAsString
Component to display in theNavPanel.navDeckwhen thisNavItemis selected.A component can be provided directly, or its ID can be provided.
- Returns:
- Current pane value. Default value is null
- See Also:
-
setTitle
Title to show for thisNavItem. -
getTitle
Title to show for thisNavItem.
-