org.gluu.credmanager.ui.vm.admin.CustomBrandingViewModel クラス

org.gluu.credmanager.ui.vm.admin.CustomBrandingViewModel の継承関係図

org.gluu.credmanager.ui.vm.admin.CustomBrandingViewModel 連携図

公開メンバ関数
String	getBrandingOption ()
String	getBrandingPath ()
CssSnippetHandler	getSnippetHandler ()
boolean	isUiOverrideButtonColors ()
void	init ()
void	changeBranding (@BindingParam("val") String option)
void	logoUploaded (@BindingParam("evt") UploadEvent evt)
void	faviconUploaded (@BindingParam("evt") UploadEvent evt)
void	save ()
void	buttonColorChanging (@BindingParam("override") boolean override) throws Exception
String	getSubpage ()
List< AdminConsoleMenuItem >	getExtraButtons ()
void	loadSubPage (@BindingParam("page") String page)
MainSettings	getSettings ()

関数
boolean	updateMainSettings (String sucessMessage)
boolean	updateMainSettings ()

非公開メンバ関数
String	processImageMedia (Media media)
void	updateSettings (String brandPath, String cssSnippet)

非公開変数類
Logger	logger = LoggerFactory.getLogger(getClass())
ZKService	zkService
MainSettings	settings
BrandingOption	brandingOption
String	brandingPath
CssSnippetHandler	snippetHandler
boolean	uiOverrideButtonColors

静的非公開変数類
static final String	GLUU_LOGO_URL = "/images/default_logo.png"

詳解

著者

jgomer

関数詳解

buttonColorChanging()

void org.gluu.credmanager.ui.vm.admin.CustomBrandingViewModel.buttonColorChanging ( @BindingParam("override") boolean  override ) throws Exception

inline

                                                                                                 {
        uiOverrideButtonColors = override;
        if (override) {
            snippetHandler.assignMissingButtonColors();
        }
    }

changeBranding()

void org.gluu.credmanager.ui.vm.admin.CustomBrandingViewModel.changeBranding ( @BindingParam("val") String  option )

inline

                                                                   {

        brandingOption = BrandingOption.valueOf(option);
        switch (brandingOption) {
            case NONE:
                break;
            case CUSTOM_PATH:
                brandingPath = settings.getBrandingPath();
                break;
            case EXTRA_CSS:
                snippetHandler = new CssSnippetHandler(settings.getExtraCssSnippet());
                if (snippetHandler.getFaviconDataUri() == null) {
                    snippetHandler.setFaviconDataUri(zkService.getFaviconDataUri());
                }
                if (snippetHandler.getLogoDataUri() == null) {
                    snippetHandler.setLogoDataUri(zkService.getLogoDataUri());
                }
                snippetHandler.assignMissingHeaderColors();
                uiOverrideButtonColors = snippetHandler.getMainButtonColor() != null;
                break;
            default:
                //Added to pass style check
        }

    }

faviconUploaded()

void org.gluu.credmanager.ui.vm.admin.CustomBrandingViewModel.faviconUploaded ( @BindingParam("evt") UploadEvent  evt )

inline

                                                                      {

        String dataUri = processImageMedia(evt.getMedia());
        if (dataUri != null) {
            snippetHandler.setFaviconDataUri(dataUri);
        }

    }

getBrandingOption()

String org.gluu.credmanager.ui.vm.admin.CustomBrandingViewModel.getBrandingOption ( )

inline

                                      {
        return brandingOption.toString();
    }

getBrandingPath()

String org.gluu.credmanager.ui.vm.admin.CustomBrandingViewModel.getBrandingPath ( )

inline

                                    {
        return brandingPath;
    }

getExtraButtons()

List<AdminConsoleMenuItem> org.gluu.credmanager.ui.vm.admin.MainViewModel.getExtraButtons ( )

inlineinherited

                                                        {
        return extraButtons;
    }

getSettings()

MainSettings org.gluu.credmanager.ui.vm.admin.MainViewModel.getSettings ( )

inlineinherited

                                      {
        return confHandler.getSettings();
    }

getSnippetHandler()

CssSnippetHandler org.gluu.credmanager.ui.vm.admin.CustomBrandingViewModel.getSnippetHandler ( )

inline

                                                 {
        return snippetHandler;
    }

getSubpage()

String org.gluu.credmanager.ui.vm.admin.MainViewModel.getSubpage ( )

inlineinherited

                               {
        return subpage;
    }

init()

void org.gluu.credmanager.ui.vm.admin.CustomBrandingViewModel.init ( )

inline

                       {
        settings = getSettings();
        boolean pathPresent = Utils.isNotEmpty(settings.getBrandingPath());
        boolean cssSnippetPresent = Utils.isNotEmpty(settings.getExtraCssSnippet());

        if (pathPresent) {
            brandingOption = BrandingOption.CUSTOM_PATH;
        } else if (cssSnippetPresent) {
            brandingOption = BrandingOption.EXTRA_CSS;
        } else {
            brandingOption = BrandingOption.NONE;
        }
        changeBranding(brandingOption.toString());

    }

isUiOverrideButtonColors()

boolean org.gluu.credmanager.ui.vm.admin.CustomBrandingViewModel.isUiOverrideButtonColors ( )

inline

                                              {
        return uiOverrideButtonColors;
    }

loadSubPage()

void org.gluu.credmanager.ui.vm.admin.MainViewModel.loadSubPage ( @BindingParam("page") String  page )

inlineinherited

Changes the page loaded in the content area. Also sets values needed in the UI (these are taken directly from calls to AdminService's getConfigSettings method.

引数

page	The (string) url of the page that must be loaded (by default /admin/default.zul is being shown)

                                                               {
        subpage = page;
    }

logoUploaded()

void org.gluu.credmanager.ui.vm.admin.CustomBrandingViewModel.logoUploaded ( @BindingParam("evt") UploadEvent  evt )

inline

                                                                   {

        String dataUri = processImageMedia(evt.getMedia());
        if (dataUri != null) {
            snippetHandler.setLogoDataUri(dataUri);
        }

    }

processImageMedia()

String org.gluu.credmanager.ui.vm.admin.CustomBrandingViewModel.processImageMedia ( Media  media )

inlineprivate

                                                  {

        String dataUri = null;
        if (media instanceof Image) {
            try {
                logger.debug("Got file {}", media.getName());
                dataUri = Utils.getImageDataUriEncoding(media.getByteData(), media.getName());
            } catch (Exception e) {
                logger.debug(e.getMessage(), e);
                UIUtils.showMessageUI(false);
            }
        } else {
            UIUtils.showMessageUI(false, Labels.getLabel("adm.branding_quick_noimg"));
        }
        return dataUri;

    }

save()

void org.gluu.credmanager.ui.vm.admin.CustomBrandingViewModel.save ( )

inline

                       {

        switch (brandingOption) {
            case NONE:
                //Revert to original Gluu images in disk
                zkService.resetLogoDataUriEncoding(null);
                zkService.resetFaviconDataUriEncoding(null);
                updateSettings(null, null);
                break;
            case CUSTOM_PATH:
                //First predicate is required because isDirectory returns true if an empty path is provided ...
                if (Utils.isNotEmpty(brandingPath) && Files.isDirectory(Paths.get(brandingPath))) {
                    //Check directory exists
                    if (!Files.isDirectory(Paths.get(brandingPath, "images")) || !Files.isDirectory(Paths.get(brandingPath, "styles"))) {
                        Messagebox.show(Labels.getLabel("adm.branding_no_subdirs"), null,
                                Messagebox.YES | Messagebox.NO, Messagebox.QUESTION,
                                event -> {
                                    if (Messagebox.ON_YES.equals(event.getName())) {
                                        updateSettings(brandingPath, null);
                                    }
                                }
                        );
                    } else {
                        updateSettings(brandingPath, null);
                    }
                } else {
                    Messagebox.show(Labels.getLabel("adm.branding_no_dir"), null, Messagebox.OK, Messagebox.INFORMATION);
                }
                break;
            case EXTRA_CSS:
                //Update application level logo and icon
                zkService.setLogoDataUri(snippetHandler.getLogoDataUri());
                zkService.setFaviconDataUri(snippetHandler.getFaviconDataUri());
                updateSettings(null, snippetHandler.getSnippet(uiOverrideButtonColors));
                break;
            default:
                //Added to pass style check
        }
    }

updateMainSettings() [1/2]

boolean org.gluu.credmanager.ui.vm.admin.MainViewModel.updateMainSettings ( String  sucessMessage )

inlinepackageinherited

                                                     {

        boolean success = false;
        try {
            //update app-level config and persist
            getSettings().save();
            if (sucessMessage == null) {
                UIUtils.showMessageUI(true);
            } else {
                Messagebox.show(sucessMessage, null, Messagebox.OK, Messagebox.INFORMATION);
            }
            success = true;
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
            UIUtils.showMessageUI(false, Labels.getLabel("adm.conffile_error_update"));
        }
        return success;

    }

updateMainSettings() [2/2]

boolean org.gluu.credmanager.ui.vm.admin.MainViewModel.updateMainSettings ( )

inlinepackageinherited

                                 {
        return updateMainSettings(null);
    }

updateSettings()

void org.gluu.credmanager.ui.vm.admin.CustomBrandingViewModel.updateSettings ( String  brandPath, String  cssSnippet  )

inlineprivate

                                                                     {

        settings.setBrandingPath(brandPath);
        settings.setExtraCssSnippet(cssSnippet);
        String msg = Labels.getLabel(brandingOption.equals(BrandingOption.NONE) ? "adm.branding_defaulted" : "adm.branding_changed");
        updateMainSettings(msg);

    }

メンバ詳解

brandingOption

BrandingOption org.gluu.credmanager.ui.vm.admin.CustomBrandingViewModel.brandingOption

private

brandingPath

String org.gluu.credmanager.ui.vm.admin.CustomBrandingViewModel.brandingPath

private

GLUU_LOGO_URL

final String org.gluu.credmanager.ui.vm.admin.CustomBrandingViewModel.GLUU_LOGO_URL = "/images/default_logo.png"

staticprivate

logger

Logger org.gluu.credmanager.ui.vm.admin.CustomBrandingViewModel.logger = LoggerFactory.getLogger(getClass())

private

settings

MainSettings org.gluu.credmanager.ui.vm.admin.CustomBrandingViewModel.settings

private

snippetHandler

CssSnippetHandler org.gluu.credmanager.ui.vm.admin.CustomBrandingViewModel.snippetHandler

private

uiOverrideButtonColors

boolean org.gluu.credmanager.ui.vm.admin.CustomBrandingViewModel.uiOverrideButtonColors

private

zkService

ZKService org.gluu.credmanager.ui.vm.admin.CustomBrandingViewModel.zkService

private

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/OpenId/gluu/src/cred-manager/app/src/main/java/org/gluu/credmanager/ui/vm/admin/CustomBrandingViewModel.java