Package com.saperion.ngc.iform.button
Class FormButton
- java.lang.Object
-
- org.zkoss.zk.ui.AbstractComponent
-
- org.zkoss.zk.ui.HtmlBasedComponent
-
- org.zkoss.zul.impl.XulElement
-
- org.zkoss.zul.impl.LabelElement
-
- org.zkoss.zul.impl.LabelImageElement
-
- org.zkoss.zul.Button
-
- com.saperion.ngc.button.Button
-
- com.saperion.ngc.iform.button.FormButton
-
- All Implemented Interfaces:
EventChild,Localized,Identifiable,java.io.Serializable,java.lang.Cloneable,org.zkoss.zk.ui.Component,org.zkoss.zk.ui.ext.Disable,org.zkoss.zk.ui.ext.Scope,org.zkoss.zk.ui.ext.Uploadable,org.zkoss.zk.ui.sys.ComponentCtrl
public class FormButton extends Button implements EventChild, Localized, Identifiable
AButtonthat is contained in aIntelligentFormView.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from interface org.zkoss.zk.ui.Component
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE
-
Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl
AFTER_CHILD_ADDED, AFTER_CHILD_REMOVED, AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE
-
Fields inherited from interface com.saperion.ngc.events.EventChild
ALL_EVENTS, ON_ADD_LINK, ON_ADD_LOOKUP, ON_ADD_TO_FAVORITES, ON_AFTER_QUERY, ON_BUTTON, ON_BUTTON_QUERY, ON_CANCEL, ON_CANCEL_AND, ON_CANCEL_EDIT, ON_CHANGE_DOCUMENT_SECURITY, ON_CHANGE_FOLDER_SECURITY, ON_CLEAR, ON_DELETE_SELECTED, ON_DISPLAY_POPUP, ON_DISPLAY_RESULTITEM, ON_DISPLAY_TEMPORARY_DOCUMENT, ON_DOCUMENT_ADDED, ON_DOCUMENT_CHECK, ON_DOCUMENT_FILING, ON_DOCUMENT_LOCKED, ON_DOCUMENT_PROLONG_RETENTION, ON_DOCUMENT_REDUCE_DISPOSITION, ON_DOCUMENT_RELEASE, ON_DOWNLOAD_RESULTITEM, ON_EDIT_CONTENT, ON_EDIT_FOLDER, ON_EDIT_ITEM, ON_EDIT_ITEM_SELECTED, ON_EDIT_LOOKUP, ON_EDIT_SELECTED, ON_EDIT_STRUCTURE, ON_EXPORT, ON_EXTERNAL_STORAGE_UPLOAD, ON_EXTERNAL_STORAGE_UPLOAD_STATUS, ON_FAST_ACCESS_DRAG_OVER, ON_FIELD_CHANGE, ON_FILE_ACTION, ON_FILE_PREVIEW, ON_FILE_SEARCH, ON_FORM_CREATED, ON_FORM_RENDER_ERROR, ON_FORWARD, ON_IGNORE, ON_INDEX, ON_INDEX_CLEAR, ON_INDEX_RESULTITEM, ON_ITEM_DOUBLECLICK, ON_LAUNCH_WORKFLOW, ON_LOG, ON_LOGON, ON_MACRO, ON_NAVIGATION, ON_NAVIGATION_FOLDER, ON_NAVIGATION_FORM, ON_NAVIGATION_WEBPART, ON_NEW_ITEM, ON_NEW_SELECTED, ON_OK, ON_ONEDRIVE_LOGIN, ON_OPEN_INDEX_MASK, ON_OPEN_MASK, ON_OPEN_QUERY_MASK, ON_PASSWORD_EXPIRED, ON_PRINT_DOCUMENTS, ON_QUERY, ON_QUERY_FAVORITE, ON_REFRESH, ON_REFRESH_FOLDER, ON_RESET_GUI, ON_REVISION_CREATED, ON_SAVE_AND, ON_SAVE_DOC, ON_SAVE_FOLDER, ON_SCROLL_NODE, ON_SELECT_TREE_ITEM, ON_SELECTDDC, ON_SEND_MAIL_RESULTITEM, ON_SET_LITIGATION_HOLD, ON_SHAREBASE_DOCUMENT_CHECK, ON_SHAREBASE_LOGIN, ON_START_WORKFLOW, ON_TAB_SELECTED, ON_UNDELETE_SELECTED, ON_UPLOAD_DOCUMENT, ON_UPLOAD_EXTERNAL_STORAGE_DOCUMENT, ON_UPLOAD_SUCCESS, ON_VARIABLES_AVAILABLE, ON_WF, ON_WF_COMMENT_DIALOG_CANCEL, ON_WF_COMMENT_DIALOG_OK, ON_WFCOMMENTS, ON_WFDELEGATE, ON_WFFORWARD, ON_WFFORWARD1, ON_WFFORWARD2, ON_WFFORWARD3, ON_WFFORWARD4, ON_WFFORWARD5, ON_WFHISTORY, ON_WFPUTBACK, ON_WFREMINDER, ON_WFTAKE, ON_WORKFLOW_ACTION, ON_WORKFLOW_COMMENT, ON_WORKFLOW_DISPLAY_COMMENT
-
-
Constructor Summary
Constructors Constructor Description FormButton()Constructor.FormButton(com.saperion.ngc.iform.xml.ButtonType buttonType, com.saperion.ngc.iform.xml.PosType panePos, boolean isNoLocatization)Constructor.FormButton(java.lang.String label)Constructor.FormButton(java.lang.String label, java.lang.String image)Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringgenerateUUID()java.util.Set<org.zkoss.zk.ui.Component>getEventtarget(java.lang.String eventName)Reads the event target for the given event name, if set or the root element.ButtonInfo.EventTypegetEventType()com.saperion.ngc.iform.xml.ButtonKindTypegetKind()IntelligentFormViewgetParentForm()Returns the parent form or null, if this button is not part of a form.com.saperion.ngc.iform.xml.SaveActionTypegetSaveAction()com.saperion.ngc.iform.xml.WorkflowActionTypegetWorkflowAction()java.lang.StringgetZclass()booleanisNoLocalize()Returns the noLocalize parameter.booleanisUseFields()booleanisUtf8()voidonClick(org.zkoss.zk.ui.event.Event event)Handler for onClick event.voidonPageAttached(org.zkoss.zk.ui.Page newpage, org.zkoss.zk.ui.Page oldpage)voidonPageDetached(org.zkoss.zk.ui.Page page)voidpostFormButtonEvent(ButtonInfo info)Posts a FormButtonEvent.voidsetEventtarget(org.zkoss.zk.ui.Component comp, java.lang.String eventName)Set the event target.voidsetKind(com.saperion.ngc.iform.xml.ButtonKindType value)voidsetMold(java.lang.String mold)voidsetNoLocalize(boolean noLocalize)Sets the noLocalize parameter that can be used to disable localization of this component.voidsetParent(org.zkoss.zk.ui.Component parent)voidsetSaveAction(com.saperion.ngc.iform.xml.SaveActionType value)voidsetUseFields(boolean value)voidsetUtf8(boolean value)voidsetWorkflowAction(com.saperion.ngc.iform.xml.WorkflowActionType value)-
Methods inherited from class org.zkoss.zul.Button
clone, getAutodisable, getDir, getHref, getOrient, getTarget, getType, getUpload, isChildable, isDisabled, renderCrawlable, renderProperties, service, setAutodisable, setDir, setDisabled, setHref, setOrient, setTarget, setType, setUpload, updateByClient
-
Methods inherited from class org.zkoss.zul.impl.LabelImageElement
getExtraCtrl, getHoverImage, getHoverImageContent, getIconSclass, getImage, getImageContent, getPropertyAccess, getSrc, isImageAssigned, setHoverImage, setHoverImageContent, setHoverImageContent, setIconSclass, setImage, setImageContent, setImageContent, setSrc
-
Methods inherited from class org.zkoss.zul.impl.XulElement
getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributes
-
Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent
addSclass, focus, getAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, removeSclass, removeSclass, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex, setVflex0, setVflexDirectly, setWidth, setWidth0, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly
-
Methods inherited from class org.zkoss.zk.ui.AbstractComponent
addAnnotation, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getCallback, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setPage, setPageBefore, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize
-
-
-
-
Constructor Detail
-
FormButton
public FormButton() throws NgcUiExceptionConstructor.- Throws:
NgcUiException- exception to be handled by view
-
FormButton
public FormButton(java.lang.String label, java.lang.String image) throws NgcUiExceptionConstructor.- Parameters:
label- Labelimage- Image- Throws:
NgcUiException- exception to be handled by view
-
FormButton
public FormButton(java.lang.String label) throws NgcUiExceptionConstructor.- Parameters:
label- Label- Throws:
NgcUiException- exception to be handled by view
-
FormButton
public FormButton(com.saperion.ngc.iform.xml.ButtonType buttonType, com.saperion.ngc.iform.xml.PosType panePos, boolean isNoLocatization) throws NgcUiExceptionConstructor.- Parameters:
buttonType- Button typepanePos- Pane positionisNoLocatization- disables the localization of this button- Throws:
NgcUiException- exception to be handled by view
-
-
Method Detail
-
getZclass
public java.lang.String getZclass()
- Overrides:
getZclassin classorg.zkoss.zul.Button
-
onClick
public final void onClick(org.zkoss.zk.ui.event.Event event)
Handler for onClick event.- Parameters:
event- event
-
getEventType
public ButtonInfo.EventType getEventType()
- Returns:
- Event name
-
setMold
public void setMold(java.lang.String mold)
- Specified by:
setMoldin interfaceorg.zkoss.zk.ui.Component- Overrides:
setMoldin classorg.zkoss.zk.ui.AbstractComponent- See Also:
AbstractComponent.setMold(java.lang.String)
-
getKind
public final com.saperion.ngc.iform.xml.ButtonKindType getKind()
- Returns:
- the kind
-
setKind
public final void setKind(com.saperion.ngc.iform.xml.ButtonKindType value) throws NgcUiException- Parameters:
value- the kind to set- Throws:
NgcUiException- exception to be handled by view
-
isUseFields
public final boolean isUseFields()
- Returns:
- the useFields
-
setUseFields
public final void setUseFields(boolean value) throws NgcUiException- Parameters:
value- the useFields to set- Throws:
NgcUiException- exception to be handled by view
-
getSaveAction
public final com.saperion.ngc.iform.xml.SaveActionType getSaveAction()
- Returns:
- the saveAction
-
setSaveAction
public final void setSaveAction(com.saperion.ngc.iform.xml.SaveActionType value) throws NgcUiException- Parameters:
value- the saveAction to set- Throws:
NgcUiException- exception to be handled by view
-
isUtf8
public final boolean isUtf8()
- Returns:
- the utf8
-
setUtf8
public final void setUtf8(boolean value) throws NgcUiException- Parameters:
value- the utf8 to set- Throws:
NgcUiException- exception to be handled by view
-
getWorkflowAction
public final com.saperion.ngc.iform.xml.WorkflowActionType getWorkflowAction()
- Returns:
- the workflowAction
-
setWorkflowAction
public final void setWorkflowAction(com.saperion.ngc.iform.xml.WorkflowActionType value) throws NgcUiException- Parameters:
value- the workflowAction to set- Throws:
NgcUiException- exception to be handled by view
-
getEventtarget
public java.util.Set<org.zkoss.zk.ui.Component> getEventtarget(java.lang.String eventName)
Reads the event target for the given event name, if set or the root element.- Specified by:
getEventtargetin interfaceEventChild- Parameters:
eventName- Event name or null for main target- Returns:
- Set of event targets
- See Also:
EventChildHandlerImpl.getEventtarget(java.lang.String)
-
postFormButtonEvent
public void postFormButtonEvent(ButtonInfo info)
Posts a FormButtonEvent.- Parameters:
info- information about the button pressed.- See Also:
EventChildHandlerImpl.postFormButtonEvent(com.saperion.ngc.iform.button.ButtonInfo)
-
setEventtarget
public void setEventtarget(org.zkoss.zk.ui.Component comp, java.lang.String eventName)Set the event target.- Specified by:
setEventtargetin interfaceEventChild- Parameters:
comp- Event targeteventName- Event name or null for main target- See Also:
EventChildHandlerImpl.setEventtarget(org.zkoss.zk.ui.Component, java.lang.String)
-
setParent
public void setParent(org.zkoss.zk.ui.Component parent)
- Specified by:
setParentin interfaceorg.zkoss.zk.ui.Component- Overrides:
setParentin classorg.zkoss.zk.ui.AbstractComponent- See Also:
AbstractComponent.setParent(org.zkoss.zk.ui.Component)
-
onPageAttached
public void onPageAttached(org.zkoss.zk.ui.Page newpage, org.zkoss.zk.ui.Page oldpage)- Specified by:
onPageAttachedin interfaceorg.zkoss.zk.ui.sys.ComponentCtrl- Overrides:
onPageAttachedin classorg.zkoss.zk.ui.AbstractComponent- See Also:
AbstractComponent.onPageAttached(org.zkoss.zk.ui.Page, org.zkoss.zk.ui.Page)
-
onPageDetached
public void onPageDetached(org.zkoss.zk.ui.Page page)
- Specified by:
onPageDetachedin interfaceorg.zkoss.zk.ui.sys.ComponentCtrl- Overrides:
onPageDetachedin classorg.zkoss.zk.ui.AbstractComponent- See Also:
AbstractComponent.onPageDetached(org.zkoss.zk.ui.Page)
-
getParentForm
public IntelligentFormView getParentForm()
Returns the parent form or null, if this button is not part of a form.- Returns:
- parent for or null
-
isNoLocalize
public boolean isNoLocalize()
Description copied from interface:LocalizedReturns the noLocalize parameter.- Specified by:
isNoLocalizein interfaceLocalized- Returns:
- noLocalize
-
setNoLocalize
public void setNoLocalize(boolean noLocalize)
Description copied from interface:LocalizedSets the noLocalize parameter that can be used to disable localization of this component.- Specified by:
setNoLocalizein interfaceLocalized- Parameters:
noLocalize- value
-
generateUUID
public java.lang.String generateUUID()
- Specified by:
generateUUIDin interfaceIdentifiable- Returns:
- the generated uuid for the DOM tree
-
-