Class EditMemberPhotoHandler
- All Implemented Interfaces:
JcmsConstants,JaliosConstants
Member photo.- 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
FieldsModifier and TypeFieldDescriptionstatic final intprotected intprotected static final StringThe parameter name used to transfert the id of the Member for which the photo is edited.protected Memberprotected booleanstatic final intprotected booleanprotected intprotected intprotected intprotected intprotected intFields inherited from class com.jalios.jcms.handler.EditMemberHandler
address, admin, anonymousOpOnly, appearanceHasChanged, 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, workingMember, zoneIdFields inherited from class com.jalios.jcms.handler.EditDataHandler
id, isDeleteForced, opCancel, opCreate, opDelete, opRefresh, opUpdate, resultOpCreate, resultOpDelete, resultOpUpdateFields inherited from class com.jalios.jcms.handler.JcmsFormHandler
contextMap, csrfValidationEnabled, editFieldSet, formStep, noRedirect, noSendRedirect, op, openTabId, opFinish, opNext, opPrevious, popupEdition, redirect, redirectOnClosePopup, workspaceForcedFields 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_MODULE_SET_ATTRIBUTE, JAVASCRIPT_SET_ATTRIBUTE, jsboSet, jsfoSet, out, pageContext, SHOW_EDIT_ICON, STYLE_HEADERFields 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, workspaceFields 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_YEARFields inherited from interface com.jalios.jcms.JcmsConstants
ADATE_SEARCH, 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, GENERATIONAL_STORE_DIRECTORY, 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, PHOTO_XLARGE, PHOTO_XLARGE_HEIGHT, PHOTO_XLARGE_PROP_PREFIX, PHOTO_XLARGE_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_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, SVGSPRITE_ICON_PREFIX, TEMPLATE_TAB, THEME_DIR, 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, TYPES_UNKNOWN_CLASS_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 -
Method Summary
Modifier and TypeMethodDescriptionstatic booleanReturn true if a given member can edit the profile info of a given member.intintintintintintintRetrieve the total number of steps used for edition when invoking this form handler.Retrieve the File instance of the current photo being edited.protected booleanbooleanMethod to be implemented to check/validate action to be performed and process them.voidvoidvoidvoidsetOpExisting(String opExisting) voidsetUseCurrentMemberPhoto(boolean useCurrentMemberPhoto) voidvoidvoidvoidvoidbooleanCheck if the "Previous" button should be displayed in step modal form.booleanprotected booleanMethods inherited from class com.jalios.jcms.handler.EditMemberHandler
alertSignup, buildAlertRuleSet, canAccessAdvancedMemberEdition, canDelete, canPublish, canUpdate, canUploadPhoto, checkValidateMember, getAddressSettings, getAdminSettings, getAppearanceSettings, getAssistantSettings, getAuthTypeSettings, getAvailableAddress, getAvailableAdmin, getAvailableAlertRuleSet, getAvailableAppearance, getAvailableAssistant, getAvailableAuthType, getAvailableClearanceLevel, getAvailableColor, getAvailableCountry, getAvailableDeclaredManager, getAvailableDelegateMemberSet, getAvailableDepartment, getAvailableEditCatMode, getAvailableEmail, getAvailableEmailVisible, getAvailableFirstName, getAvailableGroups, getAvailableInfo, getAvailableJobTitle, getAvailableLanguage, getAvailableLdapSync, getAvailableLocality, getAvailableLogin, getAvailableMobile, getAvailableName, getAvailableOrganization, getAvailablePhone, getAvailablePhoto, getAvailablePoBox, getAvailablePostalCode, getAvailableReadCategorySet, getAvailableRegion, getAvailableSalutation, getAvailableSalutValues, getAvailableStreet, getAvailableUsage, getAvailableUseCategorySet, getAvailableUseCatMode, getAvailableZoneId, getCategorySet, getClearanceLevelSettings, getColorSettings, getCountrySettings, getDataClass, getDeclaredManagerSettings, getDelegateMbrIdsSettings, getDepartmentSettings, getEmailSettings, getEmailVisibleSettings, getFieldStatus, getFirstNameSettings, getGroupRight, getGroups, getInfoSettings, getJobTitleSettings, getLanguageSettings, getLdapSyncSettings, getLocalitySettings, getLoginSettings, getMemberAlertSettingsHandler, getMobileSettings, getNameSettings, getOrganizationSettings, getPageTitle, getPassword0, getPassword0Settings, getPassword1, getPassword1Settings, getPassword2, getPassword2Settings, getPhoneSettings, getPhotoSettings, getPoBoxSettings, getPostalCodeSettings, getProfileEditor, getRegionSettings, getSalutationSettings, getShowCharter, getStreetSettings, getTimeZoneSettings, getUsageSettings, isAccount, isCategoryGroupRight, isDBAccount, isDefaultAlertRuleSet, isExpanded, isGroupRight, isGuest, isLdapAccount, isMyProfile, passwordValidatesComplexityRegex, passwordValidatesMaximumLength, passwordValidatesMinimumLength, performConfirmSignup, performConvertToMember, performCreate, performDelete, performDetachFromLDAP, performDisable, performSignup, performUpdate, releaseDBWorkingMember, sendRedirect, setAddress, setAdmin, setAlertChannels, setAlertDomainNames, setAlertLevels, setAnonymousOpOnly, setAppearance, setAssistant, setAuthType, setCanDelete, setCanPublish, setCanUpdate, setCharterAccepted, setCharterRefused, setCids, setClearanceLevel, setColor, setCountry, setDeclaredManager, setDelegateMbrIds, setDepartment, setEditCatMode, setEmail, setEmailVisible, setEncodedAlertRules, setFields, setFirstName, setGids, setGroupRight, setId, setInfo, setJobTitle, setLanguage, setLdapSync, setLocality, setLogin, setMemberAlertSettingsFormHandler, setMemberPhoto, setMid, setMobile, setName, setNotificationFormHandler, setOpAddItem, setOpConfirmSignup, setOpConvertToMember, setOpDetachFromLDAP, setOpDisable, setOpSignup, setOpUpdateProfile, setOrganization, setPassword0, setPassword1, setPassword2, setPhone, setPhoto, setPoBox, setPostalCode, setProfileEditor, setReadcids, setRegion, setRemovePhoto, setSalutation, setSignupKey, setStreet, setUsage, setUseCatMode, setUsecids, setZoneId, showAddressField, showAdminField, showAlertRuleEditor, showAppearanceField, showAssistant, showClearanceLevel, showColorField, showCountryField, showCurrentPasswordField, showDeclaredManager, showDelegateMemberSet, showGroupsTab, showInfoField, showLanguageField, showLdapSyncField, showLoginField, showNotificationForm, showPasswordFields, showPhotoField, showProfilingForm, showRightsTab, showSalutationField, showTimeZoneField, updateControlSettings, validateAddItem, validateCommonCreateSignup, validateCommonCreateSignup, validateCommonUpdate, validateConfirmSignup, validateConvertToMember, validateCreate, validateDelete, validateDetachFromLDAP, validateDisable, validateMember, validatePasswordsRules, validateSignup, validateUpdate, validateUpdateAlertSettings, validateUpdateProfileMethods inherited from class com.jalios.jcms.handler.EditDataHandler
afterValidation, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, getAvailableData, getAvailableDataArray, getAvailableExtraDataMap, getAvailableExtraDBDataMap, getAvailableField, getControllerContext, getDeleteRedirect, getEnumLabels, getEnumValues, getId, getModalRedirect, getTabGroupMaxCount, handleRestResponse, isExtraDataHidden, isFirstAccess, performCancel, performRefresh, processDataId, processDataIds, processDataIds, processMLData, processMLDataArray, restValidation, setExtraDBKeys, setExtraDBValues, setExtraKeys, setExtraValues, setFields, setForceDelete, setOpCancel, setOpCreate, setOpDelete, setOpRefresh, setOpUpdate, validateCancel, validateRefresh, validateUploadedFileDocument, validateUploadedFileDocument, validateUploadedFileDocument, validateUploadedFileDocumentMethods 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, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getMonolingualValue, getMonolingualValueArray, getMultilingualMainValue, getMultilingualMainValueArray, getMultilingualMLMap, getMultilingualMLMapArray, getOpenTabId, getRedirect, getRedirectOnClosePopup, getWorkspace, init, isFieldEdition, isFieldMissing, isFormStepClickable, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, mapStringArrayToMapStringList, mapStringListToMapStringArray, mustSendForbiddenOnCSRF, performNext, performPrevious, processStatus, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setOpenTabId, setOpFinish, setOpNext, setOpPrevious, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, showCancelButton, showFinishButton, showNextButton, startProcess, updateUploadedFields, validate, validateCSRF, validateFinish, validatePreviousMethods inherited from class com.jalios.jcms.context.JcmsJspContext
addAvoidanceLink, addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHandlebarTemplate, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addJavaScriptModule, addPrefetchHeader, addStyleHeader, addStyleHeader, addSvgSpriteIcon, addWebAssets, canAccessAdminArea, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getAvoidanceLinks, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptModuleSet, getFinalJavaScriptSet, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHandlebarTemplates, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptModuleSet, getJavaScriptSet, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getSvgSprites, getSvgSpritesHtml, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isEditIconForPublish, isEditIconForPublish, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, showEditIconMethods inherited from class com.jalios.jcms.context.JcmsContext
addMsg, addMsg, addMsgSession, addMsgSession, addToastr, addToastr, addToastrSession, addToastrSession, applySelector, canAccessAdminArea, 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, getUploadedFiles, getUploadedFiles, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getUserZoneId, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAdminZone, isAjaxRequest, isDBMember, isDebug, isDebugTemplate, isInFrontOffice, isLogged, isWorkZone, removeMessage, removeMessage, removeMsg, 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 Details
-
UPLOAD_STEP
public static final int UPLOAD_STEP- See Also:
-
CROP_STEP
public static final int CROP_STEP- See Also:
-
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
-
MBRID_HTML_PARAM
The parameter name used to transfert the id of the Member for which the photo is edited.- See Also:
-
-
Constructor Details
-
EditMemberPhotoHandler
public EditMemberPhotoHandler()
-
-
Method Details
-
processAction
Description 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:
IOException- IO Exception
-
getFormStepPrefixProp
- Overrides:
getFormStepPrefixPropin classJcmsFormHandler- Returns:
- the prefix prop for the steps
-
validateNext
- Overrides:
validateNextin classJcmsFormHandler- Throws:
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
- Overrides:
getFormStepHiddenFieldsin classJcmsFormHandler
-
performFinish
- Overrides:
performFinishin classJcmsFormHandler- Throws:
IOException
-
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
-
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
-
setY1
-
setX2
-
setY2
-
setWidth
-
setHeight
-
setMbrId
-
setMember
-
getMember
- Overrides:
getMemberin classEditMemberHandler
-
canEdit
Return true if a given member can edit the profile info of a given member.
-