|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.smartgwt.client.widgets.BaseWidget
com.smartgwt.client.widgets.Canvas
com.smartgwt.client.widgets.layout.Layout
com.smartgwt.client.widgets.toolbar.ToolStrip
public class ToolStrip
Base class for creating toolstrips like those found in browsers and office applications: a mixed set of controls
including icon buttons, radio button groups, menus, comboBoxes, spacers, status displays and drop-down selects.
All of the
above components are placed in the members array to
form a ToolStrip. Note that the FormItems mentioned above
(ComboBox and drop-down selects) need to be placed within a DynamicForm as
usual.
The special strings "separator" and "resizer" can be placed in the members array to create separators and resizers respectively.
Also see the ToolStrips Example example in the Feature Explorer.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject |
|---|
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled |
| Field Summary |
|---|
| Fields inherited from class com.smartgwt.client.widgets.BaseWidget |
|---|
config, configOnly, id, isElementSet, nativeObject, scClassName |
| Fields inherited from class com.google.gwt.user.client.ui.UIObject |
|---|
DEBUG_ID_PREFIX |
| Constructor Summary | |
|---|---|
ToolStrip()
|
|
ToolStrip(JavaScriptObject jsObj)
|
|
| Method Summary | |
|---|---|
void |
addButton(ToolStripButton button)
Add a button to the ToolStrip. |
void |
addButton(ToolStripButton button,
int position)
Add a button to the ToolStrip. |
void |
addFill()
Adds a LayoutSpacer to the ToolStrip to take up space such like a normal member, without actually drawing anything. |
void |
addFormItem(FormItem formItem)
Add a FormItem to the ToolStrip. |
void |
addFormItem(FormItem formItem,
int position)
Add a FormItem to the ToolStrip. |
void |
addMenuButton(ToolStripMenuButton button)
Add a menu button to the ToolStrip. |
void |
addMenuButton(ToolStripMenuButton button,
int position)
Add a menu button to the ToolStrip. |
void |
addResizer()
Add a resizer |
void |
addSeparator()
Add a separator. |
void |
addSpacer(int space)
Add an extra space to the right of the previously added ToolStrip element. |
void |
addSpacer(ToolStripSpacer toolStripSpacer)
Add an extra space to the right of the previously added ToolStrip element. |
protected JavaScriptObject |
create()
|
Alignment |
getGroupTitleAlign()
If set, this attribute affects the alignment of the titles in ToolStripGroups. |
VerticalAlignment |
getGroupTitleOrientation()
If set, this attribute affects the orientation of the titles in ToolStripGroups. |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
getLogicalStructure()
|
static ToolStrip |
getOrCreateRef(JavaScriptObject jsObj)
|
String |
getResizeBarClass()
Customized resizeBar with typical appearance for a ToolStrip. |
int |
getResizeBarSize()
Thickness of the resizeBars in pixels. |
String |
getSeparatorClass()
Class to create when the string "separator" appears in members. |
int |
getSeparatorSize()
Separator thickness in pixels |
Boolean |
getShowGroupTitle()
If set, this attribute affects whether ToolStripGroups in
this ToolStrip show their header control. |
Boolean |
getVertical()
Indicates whether the components are drawn horizontally from left to right (false), or vertically from top to bottom (true). |
String |
getVerticalStyleName()
Default stylename to use if this.vertical is true. |
static void |
setDefaultProperties(ToolStrip toolStripProperties)
Class level method to set the default properties of this class. |
void |
setGroupTitleAlign(Alignment groupTitleAlign)
If set, this attribute affects the alignment of the titles in ToolStripGroups. |
void |
setGroupTitleOrientation(VerticalAlignment groupTitleOrientation)
If set, this attribute affects the orientation of the titles in ToolStripGroups. |
void |
setJavaScriptObject(JavaScriptObject jsObj)
|
com.smartgwt.logicalstructure.core.LogicalStructureObject |
setLogicalStructure(com.smartgwt.logicalstructure.widgets.toolbar.ToolStripLogicalStructure s)
|
void |
setResizeBarClass(String resizeBarClass)
Customized resizeBar with typical appearance for a ToolStrip. |
void |
setResizeBarSize(int resizeBarSize)
Thickness of the resizeBars in pixels. |
void |
setSeparatorClass(String separatorClass)
Class to create when the string "separator" appears in members. |
void |
setSeparatorSize(int separatorSize)
Separator thickness in pixels |
void |
setShowGroupTitle(Boolean showGroupTitle)
If set, this attribute affects whether ToolStripGroups in
this ToolStrip show their header control. |
void |
setVertical(Boolean vertical)
Indicates whether the components are drawn horizontally from left to right (false), or vertically from top to bottom (true). |
void |
setVerticalStyleName(String verticalStyleName)
Default stylename to use if this.vertical is true. |
| Methods inherited from class com.google.gwt.user.client.ui.Widget |
|---|
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents |
| Methods inherited from class com.google.gwt.user.client.ui.UIObject |
|---|
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
|---|
fireEvent |
| Constructor Detail |
|---|
public ToolStrip()
public ToolStrip(JavaScriptObject jsObj)
| Method Detail |
|---|
public static ToolStrip getOrCreateRef(JavaScriptObject jsObj)
public void setJavaScriptObject(JavaScriptObject jsObj)
setJavaScriptObject in class Layoutprotected JavaScriptObject create()
create in class Layout
public void setGroupTitleAlign(Alignment groupTitleAlign)
throws IllegalStateException
ToolStripGroups. You can override this at the individual ToolStripGroup level.
groupTitleAlign - groupTitleAlign Default value is "center"
IllegalStateException - this property cannot be changed after the component has been createdpublic Alignment getGroupTitleAlign()
ToolStripGroups. You can override this at the individual ToolStripGroup level.
public void setGroupTitleOrientation(VerticalAlignment groupTitleOrientation)
throws IllegalStateException
ToolStripGroups. You can override this at the individual ToolStripGroup level.
groupTitleOrientation - groupTitleOrientation Default value is "top"
IllegalStateException - this property cannot be changed after the component has been createdpublic VerticalAlignment getGroupTitleOrientation()
ToolStripGroups. You can override this at the individual ToolStripGroup level.
public void setResizeBarClass(String resizeBarClass)
throws IllegalStateException
setResizeBarClass in class LayoutresizeBarClass - . See String. Default value is "ToolStripResizer"
IllegalStateException - this property cannot be changed after the component has been createdSplitbar,
ImgSplitbar,
Layout.setResizeBarSize(int)public String getResizeBarClass()
getResizeBarClass in class LayoutStringSplitbar,
ImgSplitbar,
Layout.getResizeBarSize()
public void setResizeBarSize(int resizeBarSize)
throws IllegalStateException
Note : This is an advanced setting
setResizeBarSize in class LayoutresizeBarSize - resizeBarSize Default value is 14
IllegalStateException - this property cannot be changed after the component has been createdpublic int getResizeBarSize()
getResizeBarSize in class Layout
public void setSeparatorClass(String separatorClass)
throws IllegalStateException
members.
separatorClass - . See String. Default value is "ToolStripSeparator"
IllegalStateException - this property cannot be changed after the component has been createdpublic String getSeparatorClass()
members.
String
public void setSeparatorSize(int separatorSize)
throws IllegalStateException
separatorSize - separatorSize Default value is 8
IllegalStateException - this property cannot be changed after the component has been createdpublic int getSeparatorSize()
public void setShowGroupTitle(Boolean showGroupTitle)
throws IllegalStateException
ToolStripGroups in
this ToolStrip show their header control. You can override this at the individual ToolStripGroup level.
showGroupTitle - showGroupTitle Default value is true
IllegalStateException - this property cannot be changed after the component has been createdpublic Boolean getShowGroupTitle()
ToolStripGroups in
this ToolStrip show their header control. You can override this at the individual ToolStripGroup level.
public void setVertical(Boolean vertical)
throws IllegalStateException
setVertical in class Layoutvertical - vertical Default value is false
IllegalStateException - this property cannot be changed after the component has been createdAppearance overview and related methodspublic Boolean getVertical()
getVertical in class LayoutAppearance overview and related methods
public void setVerticalStyleName(String verticalStyleName)
throws IllegalStateException
this.vertical is true. If
unset, the standard styleName will be used for both
vertical and horizontal toolstrips. Note that this property only applies to the widget at init time. To modify the
styleName after this widget has been initialized, you should simply call setStyleName() rather than updating this property.
verticalStyleName - . See CSSClassName. Default value is null
IllegalStateException - this property cannot be changed after the component has been createdAppearance overview and related methodspublic String getVerticalStyleName()
this.vertical is true. If
unset, the standard styleName will be used for both
vertical and horizontal toolstrips. Note that this property only applies to the widget at init time. To modify the
styleName after this widget has been initialized, you should simply call setStyleName() rather than updating this property.
CSSClassNameAppearance overview and related methodspublic static void setDefaultProperties(ToolStrip toolStripProperties)
Note: This method is intended for setting default attributes only and will effect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead.
toolStripProperties - properties that should be used as new defaults when instances of this class are createdpublic void addFormItem(FormItem formItem)
formItem - the formItem
public void addFormItem(FormItem formItem,
int position)
formItem - the FormItemposition - the position in the layout to place newMember (starts with 0); if omitted, it will be added at
the last positionpublic void addButton(ToolStripButton button)
button - the toolstrip button
public void addButton(ToolStripButton button,
int position)
button - the buttonposition - the position in the layout to place newMember (starts with 0); if omitted, it will be added at
the last positionpublic void addMenuButton(ToolStripMenuButton button)
button - the toolstrip menu button
public void addMenuButton(ToolStripMenuButton button,
int position)
button - the menu buttonposition - the position in the layout to place newMember (starts with 0); if omitted, it will be added at
the last positionpublic void addSpacer(int space)
addSpacer(ToolStripSpacer).
space - spacepublic void addSpacer(ToolStripSpacer toolStripSpacer)
toolStripSpacer - the toolstip spacer.public void addFill()
alignment
of the ToolStrip.
public void addSeparator()
separator.
public void addResizer()
resizer
public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.toolbar.ToolStripLogicalStructure s)
public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
getLogicalStructure in interface LogicalStructuregetLogicalStructure in class Layout
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||