Groovy Documentation

org.grails.plugin.vaadin.ui
[Groovy] Class StartupUriFragmentUtility

java.lang.Object
  com.vaadin.ui.AbstractComponent
      com.vaadin.ui.UriFragmentUtility
          org.grails.plugin.vaadin.ui.StartupUriFragmentUtility

class StartupUriFragmentUtility
extends UriFragmentUtility

A special UriFragmentUtility that forces the browser to send the initial fragment only when the application first starts. Thereafter, it behaves exactly like the UriFragmentUtility.

Note that UriFragmentUtility will not send a fragment changed event if the server-side fragment is the same as the browser-side fragment. This means that we don't get any fragment information when the app first starts. This class is designed to get around that by forcing the browser to send its fragment when the app first loads.

Authors:
Francis McKenzie


Property Summary
boolean firstPaintDone

Used to control when to send the garbage fragment to the client to force the new fragment to be sent.

 
Constructor Summary
StartupUriFragmentUtility()

 
Method Summary
void paintContent(PaintTarget target)

Send a garbage fragment on first 'paint', to force the browser to send us the true fragment.

void restart()

Forces utility to send fragment on next paint.

 
Methods inherited from class UriFragmentUtility
getFragment, setFragment, setFragment, addListener, removeListener, paintContent, changeVariables, getParent, setReadOnly, isReadOnly, setParent, getData, setLocale, getDescription, paint, getListeners, isVisible, isEnabled, setEnabled, setVisible, getLocale, getWidth, getHeight, setIcon, getIcon, setWidth, setWidth, setWidth, setDescription, getErrorMessage, setErrorHandler, getErrorHandler, addListener, addListener, addListener, addListener, getStyle, setStyle, setData, attach, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, getStyleName, setStyleName, addStyleName, removeStyleName, getCaption, setCaption, getWindow, getApplication, detach, childRequestedRepaint, setDebugId, getDebugId, requestRepaintRequests, isImmediate, setHeight, setHeight, setHeight, getWidthUnits, setWidthUnits, getHeightUnits, setHeightUnits, setSizeFull, setSizeUndefined, setImmediate, getComponentError, setComponentError, handleError, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 
Methods inherited from class AbstractComponent
getParent, setReadOnly, isReadOnly, setParent, getData, setLocale, getDescription, paint, getListeners, isVisible, isEnabled, setEnabled, setVisible, getLocale, getWidth, getHeight, setIcon, getIcon, setWidth, setWidth, setWidth, setDescription, getErrorMessage, setErrorHandler, getErrorHandler, addListener, addListener, addListener, addListener, getStyle, setStyle, setData, attach, removeListener, removeListener, removeListener, removeListener, removeListener, paintContent, requestRepaint, changeVariables, getStyleName, setStyleName, addStyleName, removeStyleName, getCaption, setCaption, getWindow, getApplication, detach, childRequestedRepaint, setDebugId, getDebugId, requestRepaintRequests, isImmediate, setHeight, setHeight, setHeight, getWidthUnits, setWidthUnits, getHeightUnits, setHeightUnits, setSizeFull, setSizeUndefined, setImmediate, getComponentError, setComponentError, handleError, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Property Detail

firstPaintDone

boolean firstPaintDone
Used to control when to send the garbage fragment to the client to force the new fragment to be sent.

Set to true after the first call to paintContent(PaintTarget).


 
Constructor Detail

StartupUriFragmentUtility

StartupUriFragmentUtility()


 
Method Detail

paintContent

@Override
void paintContent(PaintTarget target)
Send a garbage fragment on first 'paint', to force the browser to send us the true fragment.


restart

void restart()
Forces utility to send fragment on next paint.


 

Groovy Documentation