Изменение дерева компонентов JSF в PhaseListener - PullRequest
1 голос
/ 18 марта 2010

У меня проблема.

Я реализовал PhaseListener, который предназначен для добавления класса стиля к любым компонентам UIInput в дереве, к которым прикреплены сообщения, и удаляет класс стиля, если к нему не прикреплены никакие сообщения.

PhaseListener работает в фазе RENDER_RESPONSE и работает во время отладки в методах beforePhase и afterPhase. Во время отладки я обнаружил, что beforePhase не имеет доступа к полному дереву компонентов, а afterPhase делает. Любые изменения, сделанные в afterPhase, не отображаются.

Как мне это сделать? Я хочу, чтобы это было полностью на стороне сервера.

Спасибо

Джеймс

Ответы [ 2 ]

2 голосов
/ 10 ноября 2015

Дерево компонентов JSF доступно только после времени построения представления. Фаза RENDER_RESPONSE не обязательно является подходящим моментом для получения доступа к полному дереву компонентов JSF до его визуализации. Во время первоначального запроса GET без <f:viewAction> полное дерево компонентов доступно только в afterPhase, поскольку оно создается во время RENDER_RESPONSE. Во время обратной передачи полное дерево компонентов доступно в beforePhase, однако, когда происходит переход к другому представлению, оно будет изменено во время фазы RENDER_RESPONSE, поэтому любые изменения потерялся.

Чтобы узнать, каково время сборки представления, перейдите к вопросу Каково время сборки представления?

Вы в основном хотите подключить "время рендеринга вида", а не beforePhase фазы RENDER_RESPONSE. JSF предлагает несколько способов его подключения:

  1. В каком-нибудь главном шаблоне присоедините слушателя preRenderView к <f:view>.

    <f:view ...>
        <f:event type="preRenderView" listener="#{bean.onPreRenderView}" />
        ...
    </f:view>
    
    public void onPreRenderView(ComponentSystemEvent event) {
        UIViewRoot view = (UIViewRoot) event.getSource();
        // The view is the component tree. Just modify it here accordingly.
        // ...
    }        
    
  2. Или реализовать глобальный SystemEventListener для PreRenderViewEvent.

    public class YourPreRenderViewListener implements SystemEventListener {
    
        @Override
        public boolean isListenerForSource(Object source) {
            return source instanceof UIViewRoot;
        }
    
        @Override
        public void processEvent(SystemEvent event) throws AbortProcessingException {
            UIViewRoot view = (UIViewRoot) event.getSource();
            // The view is the component tree. Just modify it here accordingly.
            // ...
        }
    
    }
    

    Чтобы запустить его, зарегистрируйте его, как показано ниже, в faces-config.xml:

    <application>
        <system-event-listener>
            <system-event-listener-class>com.example.YourPreRenderViewListener</system-event-listener-class>
            <system-event-class>javax.faces.event.PreRenderViewEvent</system-event-class>
        </system-event-listener>
    </application>
    
  3. Или укажите пользовательский ViewHandler, в котором вы выполняете работу в renderView().

    public class YourViewHandler extends ViewHandlerWrapper {
    
        private ViewHandler wrapped;
    
        public YourViewHandler(ViewHandler wrapped) {
            this.wrapped = wrapped;
        }
    
        @Override
        public void renderView(FacesContext context, UIViewRoot view) {
            // The view is the component tree. Just modify it here accordingly.
            // ...
    
            // Finally call super so JSF can do the rendering job.
            super.renderView(context, view);
        }
    
        @Override
        public ViewHandler getWrapped() {
            return wrapped;
        }
    
    }
    

    Чтобы запустить его, зарегистрируйтесь, как показано ниже, в faces-config.xml:

    <application>
        <view-handler>com.example.YourViewHandler</view-handler>
    </application>
    
  4. Или, зацепите ViewDeclarationLanguage#renderView(), но это немного на грани, поскольку на самом деле не намерено манипулировать деревом компонентов, а манипулировать способом визуализации представления.


Не имеет отношения к конкретной проблеме , все это не является правильным решением для конкретного функционального требования, как указано в вашем вопросе:

, который предназначен для добавления класса стиля к любым компонентам UIInput в дереве, к которому прикреплены сообщения, и удаляет класс стиля, если к нему не прикреплено ни одного сообщения

Вы бы лучше отправились на решение на стороне клиента, чем манипулировали деревом компонентов (которое в конечном итоге оказалось бы в состоянии компонента JSF!) Представьте себе случай ввода в итерационных компонентах, таких как <ui:repeat><h:inputText>. Физически в дереве только один входной компонент, а не несколько! Управление классом стиля с помощью UIInput#setStyleClass() будет представлено в каждом раунде итерации.

Лучше всего посетить дерево компонентов, используя UIViewRoot#visitTree(), как показано ниже, и собрать все идентификаторы клиентов недопустимых компонентов ввода (этот подход visitTree() будет прозрачно учитывать итерационные компоненты):

Set<String> invalidInputClientIds = new HashSet<>();
view.visitTree(VisitContext.createVisitContext(context, null, EnumSet.of(VisitHint.SKIP_UNRENDERED)), new VisitCallback() {

    @Override
    public VisitResult visit(VisitContext context, UIComponent component) {
        if (component instanceof UIInput) {
            UIInput input = (UIInput) component;

            if (!input.isValid()) {
                invalidInputClientIds.add(input.getClientId(context.getFacesContext()));
            }
        }

        return VisitResult.ACCEPT;
    }
});

И затем после этого передайте invalidInputClientIds в виде массива JSON в JavaScript, который затем захватит их через document.getElementById() и изменит атрибут className.

for (var i = 0; i < invalidInputClientIds.length; i++) {
    var invalidInput = document.getElementById(invalidInputClientIds[i]);
    invalidInput.className += ' error';
}

Библиотека утилит JSF OmniFaces имеет компонент <o:highlight>, который делает именно это.

0 голосов
/ 23 марта 2010

Реализовано с использованием ViewHandler, но неэффективно. PhaseListener в фазе ответа рендеринга не имеет доступа к дереву компонентов.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...