|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object zk.Object zk.Widget zul.Widget zul.LabelImageWidget zul.wgt.Button
public class Button
A button.
Default Widget.getZclass()
: z-button.
Field Summary |
---|
Fields inherited from class zk.Widget |
---|
$weave, auDelay, autag, bindLevel, className, desktop, effects_, firstChild, id, insertingBefore_, inServer, lastChild, nChildren, nextSibling, parent, previousSibling, uuid, widgetName |
Fields inherited from class zk.Object |
---|
$class, $oid |
Method Summary | |
---|---|
String |
getAutodisable()
Returns a list of component IDs that shall be disabled when the user clicks this button. |
String |
getDir()
Returns the direction. |
String |
getHref()
Returns the href that the browser shall jump to, if an user clicks this button. |
String |
getOrient()
Returns the orient. |
int |
getTabindex()
Returns the tab order of this component. |
String |
getTarget()
Returns the target frame or window. |
String |
getType()
Returns the button type. |
String |
getUpload()
Returns non-null if this button is used for file upload, or null otherwise. |
boolean |
isDisabled()
Returns whether it is disabled. |
protected boolean |
isTableLayout_()
Returns whether have to listen to onfocus and onblur event on button element. |
protected void |
renderIcon_(Array out)
Generates the HTML fragment at the right of the button layout. |
protected void |
renderInner_(Array out)
Generates the HTML fragment after the button layout table. |
void |
setAutodisable(String autodisable)
Sets whether to disable the button after the user clicks it. |
void |
setDir(String dir)
Sets the direction. |
void |
setDisabled(boolean disabled)
Sets whether it is disabled. |
void |
setHref(String href)
Sets the href. |
void |
setOrient(String orient)
Sets the orient. |
void |
setTabindex(int tabindex)
Sets the tab order of this component. |
void |
setTarget(String target)
Sets the target frame or window. |
void |
setType(String type)
Sets the button type. |
void |
setUpload(String upload)
Sets the JavaScript class at the client to handle the upload if this button is used for file upload. |
Methods inherited from class zul.LabelImageWidget |
---|
domContent_, domImage_, domLabel_, getHoverImage, getImage, getImageNode, getLabel, setHoverImage, setImage, setLabel, updateDomContent_ |
Methods inherited from class zul.Widget |
---|
afterKeyDown_, beforeCtrlKeys_, getContext, getCtrlKeys, getOpenTooltip, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip |
Methods inherited from class zk.Object |
---|
$init, $instanceof, $super, $super, $supers, $supers, afterInit, isAssignableFrom, isInstance, proxy |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public void setHref(String href)
href
- public String getHref()
Default: null. If null, the button has no function unless you specify the onClick event listener.
If it is not null, the onClick event won't be sent.
public void setTarget(String target)
target
- the name of the frame or window to hyperlink.public String getTarget()
Note: it is useful only if href (setHref(_global_.String)
) is specified
(i.e., use the onClick listener).
Default: null.
public void setDir(String dir)
dir
- either "normal" or "reverse".public String getDir()
Default: "normal".
public void setOrient(String orient)
orient
- either "horizontal" or "vertical".public String getOrient()
Default: "horizontal".
public void setType(String type)
type
- either "button", "submit" or "reset".public String getType()
Default: "button".
public void setDisabled(boolean disabled)
disabled
- public boolean isDisabled()
Default: false.
public void setTabindex(int tabindex)
tabindex
- public int getTabindex()
Default: -1 (means the same as browser's default).
public void setAutodisable(String autodisable)
autodisable
- public String getAutodisable()
To represent the button itself, the developer can specify self
.
For example,
button.setId('ok');
wgt.setAutodisable('self,cancel');
is the same as
button.setId('ok');
wgt.setAutodisable('ok,cancel');
that will disable
both the ok and cancel buttons when an user clicks it.
The button being disabled will be enabled automatically once the client receives a response from the server. In other words, the server doesn't notice if a button is disabled with this method.
However, if you prefer to enable them later manually, you can prefix with '+'. For example,
button.setId('ok');
wgt.setAutodisable('+self,+cancel');
Then, you have to enable them manually such as
if (something_happened){
ok.setDisabled(false);
cancel.setDisabled(false);
Default: null.
public void setUpload(String upload)
Default: null.
For example, the following example declares a button for file upload:
button.setLabel('Upload');
button.setUpload('true');
If you want to customize the handling of the file upload at
the client, you can specify a JavaScript class when calling
this method:
button.setUpload('foo.Upload');
Another options for the upload can be specified as follows:
button.setUpload('true,maxsize=-1,native');
upload
- a JavaScript class to handle the file upload
at the client, or "true" if the default class is used,
or null or "false" to disable the file download (and then
this button behaves like a normal button).public String getUpload()
setUpload(_global_.String)
for more details.
protected void renderIcon_(Array out)
Default: do nothing, override it as need.
out
- an array of HTML fragments.protected void renderInner_(Array out)
Default: do nothing, override it as need.
out
- an array of HTML fragments.protected boolean isTableLayout_()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |