CustomCommandButton
Inheritance: java.lang.Object, com.aspose.gridweb.Control
public class CustomCommandButton extends Control
Represents a custom command button in the tab bar of the GridWeb control.
Example
GridWebBean GridWeb1=ExtPage.getInstance().getBean();
CustomCommandButton button = new CustomCommandButton();
button.setCommand("MyCommand");
button.setImageUrl("images/button1.gif");
GridWeb1.getCustomCommandButtons().add(button);
Constructors
| Constructor | Description |
|---|---|
| CustomCommandButton() | Default constructor. |
Methods
| Method | Description |
|---|---|
| equals(Object arg0) | |
| getClass() | |
| getClientClickEvent() | Gets the click event handler at client side. |
| getCommand() | Gets the command name. |
| getCommandType() | Gets the rendering type of the command. |
| getDiscardInput() | Indicates whether to discard user input at client browser when user click this button. |
| getImageUrl() | Gets the command button’s image url. |
| getText() | Gets the alternative text of the command button. |
| getToolTip() | Gets the tooltip of the command button. |
| getUniqueID() | Gets the UniqueID in the Control |
| getVisible() | Gets the Visible in the Control |
| getWidth() | Width of the button. |
| hashCode() | |
| notify() | |
| notifyAll() | |
| setClientClickEvent(String value) | Sets the click event handler at client side. |
| setCommand(String value) | Sets the command name. |
| setCommandType(int value) | Sets the rendering type of the command. |
| setDiscardInput(boolean value) | Indicates whether to discard user input at client browser when user click this button. |
| setImageUrl(String value) | Sets the command button’s image url. |
| setText(String value) | Sets the alternative text of the command button. |
| setToolTip(String value) | Sets the tooltip of the command button. |
| setVisible(boolean value) | Sets the Visible in the Control |
| setWidth(Unit value) | Width of the button. |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
CustomCommandButton()
public CustomCommandButton()
Default constructor.
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getClientClickEvent()
public String getClientClickEvent()
Gets the click event handler at client side.
Returns: java.lang.String
getCommand()
public String getCommand()
Gets the command name.
Returns: java.lang.String
getCommandType()
public int getCommandType()
Gets the rendering type of the command. The type can be command button or context menu item.
Returns: int
getDiscardInput()
public boolean getDiscardInput()
Indicates whether to discard user input at client browser when user click this button. Could be used as an “undo” action.
Returns: boolean
getImageUrl()
public String getImageUrl()
Gets the command button’s image url. If sets to null or empty string, the button will only display it’s text.
Returns: java.lang.String
getText()
public String getText()
Gets the alternative text of the command button.
Returns: java.lang.String
getToolTip()
public String getToolTip()
Gets the tooltip of the command button.
Returns: java.lang.String
getUniqueID()
public String getUniqueID()
Gets the UniqueID in the Control
Returns: java.lang.String
getVisible()
public boolean getVisible()
Gets the Visible in the Control
Returns: boolean
getWidth()
public Unit getWidth()
Width of the button.
Returns: Unit
hashCode()
public native int hashCode()
Returns: int
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setClientClickEvent(String value)
public void setClientClickEvent(String value)
Sets the click event handler at client side.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setCommand(String value)
public void setCommand(String value)
Sets the command name.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setCommandType(int value)
public void setCommandType(int value)
Sets the rendering type of the command. The type can be command button or context menu item.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setDiscardInput(boolean value)
public void setDiscardInput(boolean value)
Indicates whether to discard user input at client browser when user click this button. Could be used as an “undo” action.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setImageUrl(String value)
public void setImageUrl(String value)
Sets the command button’s image url. If sets to null or empty string, the button will only display it’s text.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setText(String value)
public void setText(String value)
Sets the alternative text of the command button.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setToolTip(String value)
public void setToolTip(String value)
Sets the tooltip of the command button.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setVisible(boolean value)
public void setVisible(boolean value)
Sets the Visible in the Control
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setWidth(Unit value)
public void setWidth(Unit value)
Width of the button.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Unit |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |