Class EditMemberPhotoHandler
- java.lang.Object
-
- com.jalios.jcms.context.JcmsContext
-
- com.jalios.jcms.context.JcmsJspContext
-
- com.jalios.jcms.handler.JcmsFormHandler
-
- com.jalios.jcms.handler.EditDataHandler
-
- com.jalios.jcms.handler.EditMemberHandler
-
- com.jalios.jcms.handler.EditMemberPhotoHandler
-
- All Implemented Interfaces:
JcmsConstants,JaliosConstants
public class EditMemberPhotoHandler extends EditMemberHandler
This form handler processesMemberphoto.- Since:
- jcms-9.0.0
- Author:
- Kevin Bransard
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.jalios.jcms.handler.EditMemberHandler
EditMemberHandler.AuthType
-
-
Field Summary
Fields Modifier and Type Field Description static intCROP_STEPprotected intheightprotected static java.lang.StringMBRID_HTML_PARAMThe parameter name used to transfert the id of the Member for which the photo is edited.protected Membermemberprotected booleanopExistingstatic intUPLOAD_STEPprotected booleanuseCurrentMemberPhotoprotected intwidthprotected intx1protected intx2protected inty1protected inty2-
Fields inherited from class com.jalios.jcms.handler.EditMemberHandler
address, admin, anonymousOpOnly, assistant, authType, clearanceLevel, country, declaredManager, delegateMemberSet, deleteSet, department, editCatMode, email, firstName, groupRight, groupRightSet, groups, info, isCharterAccepted, isCharterRefused, isEmailVisible, isGroupEditCat, jobTitle, language, ldapSync, locality, login, mobile, name, NEWALERTRULE_MARK, newPhoto, notification, notificationFormHandler, OP_SIGNUP_PARAM, opAddItem, opConfirmSignup, opConvertToMember, opDetachFromLDAP, opDisable, opSignup, opUpdateProfile, organization, password0, password1, password2, passwordHasChanged, phone, photo, poBox, postalCode, profileEditor, publishSet, readCategorySet, region, removePhoto, rightsProvided, rootSet, salutation, showCharter, signupKey, signUpOpAuthor, skipPasswordVerification, street, updateSet, usage, useCategorySet, useCatMode, webdavAccess, workingMember, zoneId
-
Fields inherited from class com.jalios.jcms.handler.EditDataHandler
extFormHandler, id, isDeleteForced, opCancel, opCreate, opDelete, opRefresh, opUpdate, resultOpCreate, resultOpDelete, resultOpUpdate
-
Fields inherited from class com.jalios.jcms.handler.JcmsFormHandler
contextMap, csrfValidationEnabled, editFieldSet, formStep, noRedirect, noSendRedirect, op, opFinish, opNext, opPrevious, popupEdition, redirect, redirectOnClosePopup, workspaceForced
-
Fields inherited from class com.jalios.jcms.context.JcmsJspContext
AJAX_REQUEST_ATTRIBUTES, BODY_HEADER, CSS_FOOTER, CSS_HEADER, cssboMap, cssfoMap, CUSTOM_HEADER, editIcon, HTTPEQUIV_HEADER, httpequivMap, HTTPNAME_HEADER, httpnameMap, initEditIcon, JAVASCRIPT_CODE_SET_ATTRIBUTE, JAVASCRIPT_SET_ATTRIBUTE, jsboSet, jsfoSet, out, pageContext, SHOW_EDIT_ICON, STYLE_HEADER
-
Fields inherited from class com.jalios.jcms.context.JcmsContext
browser, caddy, channel, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDBMember, isDebug, isDebugTemplatePath, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, userZoneId, workspace
-
Fields inherited from interface com.jalios.util.JaliosConstants
CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR
-
Fields inherited from interface com.jalios.jcms.JcmsConstants
ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CS_TYPOLOGY_ROOT_CAT_VID, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DATA_DIRECTORY, DEFAULT_PHOTO_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, IS_IN_FRONT_OFFICE, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_MINI, PHOTO_MINI_HEIGHT, PHOTO_MINI_PROP_PREFIX, PHOTO_MINI_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SECURITY_LOG_FILE, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_DIR, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, UPLOAD_PERMISSION_COUNT_PROP_PREFIX, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML
-
-
Constructor Summary
Constructors Constructor Description EditMemberPhotoHandler()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static booleancanEdit(Member me, Member other, Workspace workspace)Return true if a given member can edit the profile info of a given member.intgetAvailableHeight()intgetAvailableWidth()intgetAvailableX1()intgetAvailableX2()intgetAvailableY1()intgetAvailableY2()intgetFormStepCount()Retrieve the total number of steps used for edition when invoking this form handler.java.lang.StringgetFormStepHiddenFields()java.lang.StringgetFormStepPrefixProp()MembergetMember()java.io.FilegetWorkFile()Retrieve the File instance of the current photo being edited.protected booleanperformFinish()booleanprocessAction()Method to be implemented to check/validate action to be performed and process them.voidsetHeight(java.lang.String height)voidsetMbrId(java.lang.String mbrId)voidsetMember(Member member)voidsetOpExisting(java.lang.String opExisting)voidsetUseCurrentMemberPhoto(boolean useCurrentMemberPhoto)voidsetWidth(java.lang.String width)voidsetX1(java.lang.String x1)voidsetX2(java.lang.String x2)voidsetY1(java.lang.String y1)voidsetY2(java.lang.String y2)booleanshowPreviousButton()Check if the "Previous" button should be displayed in step modal form.booleanuseCurrentMemberPhoto()protected booleanvalidateNext()-
Methods inherited from class com.jalios.jcms.handler.EditMemberHandler
alertSignup, buildAlertRuleSet, canDelete, canPublish, canUpdate, getAvailableAddress, getAvailableAdmin, getAvailableAlertRuleSet, getAvailableAssistant, getAvailableAuthType, getAvailableClearanceLevel, getAvailableCountry, getAvailableDeclaredManager, getAvailableDelegateMemberSet, getAvailableDepartment, getAvailableEditCatMode, getAvailableEmail, getAvailableEmailVisible, getAvailableFirstName, getAvailableGroups, getAvailableInfo, getAvailableJobTitle, getAvailableLanguage, getAvailableLdapSync, getAvailableLocality, getAvailableLogin, getAvailableMobile, getAvailableName, getAvailableOrganization, getAvailablePhone, getAvailablePoBox, getAvailablePostalCode, getAvailableReadCategorySet, getAvailableRegion, getAvailableSalutation, getAvailableStreet, getAvailableUsage, getAvailableUseCategorySet, getAvailableUseCatMode, getAvailableWebdavAccess, getAvailableZoneId, getCategorySet, getDataClass, getGroupRight, getGroups, getMemberAlertSettingsHandler, getPassword0, getPassword1, getPassword2, getProfileEditor, getShowCharter, isCategoryGroupRight, isDefaultAlertRuleSet, isExpanded, isGroupRight, passwordValidatesComplexityRegex, passwordValidatesMaximumLength, passwordValidatesMinimumLength, performConfirmSignup, performConvertToMember, performCreate, performDelete, performDetachFromLDAP, performDisable, performSignup, performUpdate, releaseDBWorkingMember, sendRedirect, setAddress, setAdmin, setAlertChannels, setAlertDomainNames, setAlertLevels, setAnonymousOpOnly, setAssistant, setAuthType, setCanDelete, setCanPublish, setCanUpdate, setCharterAccepted, setCharterRefused, setCids, setClearanceLevel, setCountry, setDeclaredManager, setDelegateMbrIds, setDepartment, setEditCatMode, setEmail, setEmailVisible, setEncodedAlertRules, setFields, setFirstName, setGids, setGroupRight, setId, setInfo, setJobTitle, setLanguage, setLdapSync, setLocality, setLogin, setMemberAlertSettingsFormHandler, setMid, setMobile, setName, setNotificationFormHandler, setOpAddItem, setOpConfirmSignup, setOpConvertToMember, setOpDetachFromLDAP, setOpDisable, setOpSignup, setOpUpdateProfile, setOrganization, setPassword0, setPassword1, setPassword2, setPhone, setPoBox, setPostalCode, setProfileEditor, setReadcids, setRegion, setRemovePhoto, setSalutation, setSignupKey, setStreet, setUsage, setUseCatMode, setUsecids, setWebdavAccess, setZoneId, showAssistant, showClearanceLevel, showDeclaredManager, showDelegateMemberSet, validateAddItem, validateCommonCreateSignup, validateCommonCreateSignup, validateCommonUpdate, validateConfirmSignup, validateConvertToMember, validateCreate, validateDelete, validateDetachFromLDAP, validateDisable, validateMember, validatePasswordsRules, validateSignup, validateUpdate, validateUpdateAlertSettings, validateUpdateProfile
-
Methods inherited from class com.jalios.jcms.handler.EditDataHandler
afterValidation, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, getAvailableData, getAvailableDataArray, getAvailableExtraDataMap, getAvailableExtraDBDataMap, getAvailableField, getControllerContext, getDeleteRedirect, getEnumLabels, getEnumValues, getExtFormHandler, getId, getModalRedirect, getTabGroupMaxCount, handleRestResponse, isFirstAccess, performCancel, performCreateExtension, performRefresh, performUpdateExtension, processDataId, processDataIds, processDataIds, processMLData, processMLDataArray, restValidation, setExtFormHandler, setExtraDBKeys, setExtraDBValues, setExtraKeys, setExtraValues, setFields, setForceDelete, setOpCancel, setOpCreate, setOpDelete, setOpRefresh, setOpUpdate, validateCancel, validateCreateExtension, validateRefresh, validateUpdateExtension, validateUploadedFileDocument, validateUploadedFileDocument, validateUploadedFileDocument, validateUploadedFileDocument
-
Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler
canStartProcess, checkMissingField, getAvailableMainLanguage, getBackgroundProcess, getClosePopupUrl, getEditFieldSet, getFormStep, getFormStepFinishLabel, getFormStepLabels, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getMonolingualValue, getMonolingualValueArray, getMultilingualMainValue, getMultilingualMainValueArray, getMultilingualMLMap, getMultilingualMLMapArray, getRedirect, getRedirectOnClosePopup, getWorkspace, init, isFieldEdition, isFieldMissing, isFormStepClickable, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, mapStringArrayToMapStringList, mapStringListToMapStringArray, mustSendForbiddenOnCSRF, performNext, performPrevious, processStatus, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setOpFinish, setOpNext, setOpPrevious, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, showCancelButton, showFinishButton, showNextButton, startProcess, updateUploadedField, updateUploadedFields, updateUploadedFields, validate, validateCSRF, validateFinish, validatePrevious
-
Methods inherited from class com.jalios.jcms.context.JcmsJspContext
addAvoidanceLink, addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHandlebarTemplate, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addPrefetchHeader, addStyleHeader, addStyleHeader, addWebAssets, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getAvoidanceLinks, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptSet, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHandlebarTemplates, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSONBridge, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isEditIconForPublish, isEditIconForPublish, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, showEditIcon, workaroundBrowserBaseHrefBug
-
Methods inherited from class com.jalios.jcms.context.JcmsContext
addCookie, addMsg, addMsg, addMsgSession, addMsgSession, addToastr, addToastr, addToastrSession, addToastrSession, applySelector, copyMsgListToMsgSessionList, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgList, getErrorMsgSession, getErrorMsgSessionList, getInfoMsg, getInfoMsgList, getInfoMsgSession, getInfoMsgSessionList, getLoggedMember, getMsgList, getMsgSessionList, getRequest, getResponse, getSession, getSuccessMsg, getSuccessMsgList, getSuccessMsgSession, getSuccessMsgSessionList, getToastrCollection, getToastrSessionCollection, getUploadedFile, getUploadedFileList, getUploadedFiles, getUploadedFiles, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getUserZoneId, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAdminZone, isAjaxRequest, isDBMember, isDebug, isDebugTemplate, isInFrontOffice, isLogged, isWebdavAccess, isWorkZone, removeMessage, removeMessage, removeMsg, retrieveUploadedFile, select, sendError, sendError, sendForbidden, sendForbidden, sendRedirect, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setSuccessMsg, setSuccessMsg, setSuccessMsgSession, setSuccessMsgSession, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, updateWorkspace, validateRegexp, validateSchedule
-
-
-
-
Field Detail
-
UPLOAD_STEP
public static final int UPLOAD_STEP
- See Also:
- Constant Field Values
-
CROP_STEP
public static final int CROP_STEP
- See Also:
- Constant Field Values
-
opExisting
protected boolean opExisting
-
useCurrentMemberPhoto
protected boolean useCurrentMemberPhoto
-
x1
protected int x1
-
y1
protected int y1
-
x2
protected int x2
-
y2
protected int y2
-
width
protected int width
-
height
protected int height
-
member
protected Member member
-
MBRID_HTML_PARAM
protected static final java.lang.String MBRID_HTML_PARAM
The parameter name used to transfert the id of the Member for which the photo is edited.- See Also:
- Constant Field Values
-
-
Method Detail
-
processAction
public boolean processAction() throws java.io.IOExceptionDescription copied from class:JcmsFormHandlerMethod to be implemented to check/validate action to be performed and process them.Default implementation is to return false. No need to call super method.
This method may NOT be invoked at all if security validation are not met.
You must ensure your handler and JSP can work properly without any code invoked in this method.
- Overrides:
processActionin classEditMemberHandler- Returns:
- false if no redirection is needed, true otherwise
- Throws:
java.io.IOException- IO Exception
-
getFormStepPrefixProp
public java.lang.String getFormStepPrefixProp()
- Overrides:
getFormStepPrefixPropin classJcmsFormHandler- Returns:
- the prefix prop for the steps
-
validateNext
protected boolean validateNext() throws java.io.IOException- Overrides:
validateNextin classJcmsFormHandler- Throws:
java.io.IOException
-
getFormStepCount
public int getFormStepCount()
Description copied from class:JcmsFormHandlerRetrieve the total number of steps used for edition when invoking this form handler.The default implementation of this method is to return 1, corresponding to one step (which means only 1 screen being displayed).
You can provide a custom FormHandler to override this behavior.
See jcore/doSteps.jspf for use of this method.
- Overrides:
getFormStepCountin classJcmsFormHandler- Returns:
- the total number of steps in this formhandler
-
showPreviousButton
public boolean showPreviousButton()
Description copied from class:JcmsFormHandlerCheck if the "Previous" button should be displayed in step modal form.The default implementation of this method is to return true if the current step (as returned by
JcmsFormHandler.getFormStep()is higher than 0.You can provide a custom FormHandler to override this behavior.
See jcore/doStepButtons.jspf for use of this method.
- Overrides:
showPreviousButtonin classJcmsFormHandler- Returns:
- true to display the "Previous" button, false to hide it
-
getFormStepHiddenFields
public java.lang.String getFormStepHiddenFields()
- Overrides:
getFormStepHiddenFieldsin classJcmsFormHandler
-
performFinish
protected boolean performFinish() throws java.io.IOException- Overrides:
performFinishin classJcmsFormHandler- Throws:
java.io.IOException
-
getWorkFile
public java.io.File getWorkFile()
Retrieve the File instance of the current photo being edited.ALWAYS return a temporary file which can be safely deleted.
- Returns:
- a File instance or null if work file was not properly initalized
-
setOpExisting
public void setOpExisting(java.lang.String opExisting)
-
setUseCurrentMemberPhoto
public void setUseCurrentMemberPhoto(boolean useCurrentMemberPhoto)
-
useCurrentMemberPhoto
public boolean useCurrentMemberPhoto()
- Returns:
- true if user has asked to use his existing photo
-
getAvailableX1
public int getAvailableX1()
-
getAvailableY1
public int getAvailableY1()
-
getAvailableX2
public int getAvailableX2()
-
getAvailableY2
public int getAvailableY2()
-
getAvailableWidth
public int getAvailableWidth()
-
getAvailableHeight
public int getAvailableHeight()
-
setX1
public void setX1(java.lang.String x1)
-
setY1
public void setY1(java.lang.String y1)
-
setX2
public void setX2(java.lang.String x2)
-
setY2
public void setY2(java.lang.String y2)
-
setWidth
public void setWidth(java.lang.String width)
-
setHeight
public void setHeight(java.lang.String height)
-
setMbrId
public void setMbrId(java.lang.String mbrId)
-
setMember
public void setMember(Member member)
-
getMember
public Member getMember()
- Overrides:
getMemberin classEditMemberHandler
-
-