litesoft
@ 811
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 |
// This Source Code is in the Public Domain per: http://litesoft.org/License.txt package org.litesoft.render; import java.util.*; import org.litesoft.core.typeutils.*; public abstract class AbstractRenderHelper implements RenderHelper { private Object mRectangularRenderableObject; private RenderAccessor mRenderAccessor; private RenderSizingApproach mSizingApproach; private RenderParticipatingAdapter mParticipatingAdapter; private RenderDimensionAdapter mDimensionAdapter; private int mIgnoreInitialNonParticipatingSize; private int mIgnoreReportedSize; private Integer mLastReportedSize = null; private Boolean mParticipatingInRendering = null; protected final String mRROname; protected final DetermineRectSizeNowRHP mDetermineRectSizeNow; private LayoutState mLayoutState = LayoutState.Initial; private static TraceLogger sTraceLogger; protected AbstractRenderHelper( Object pRectangularRenderableObject, // RenderAccessor pRenderAccessor, // RenderSizingApproach pSizingApproach, // RenderParticipatingAdapter pParticipatingAdapter, // RenderDimensionAdapter pDimensionAdapter ) { Objects.assertNotNull( "RRO", mRectangularRenderableObject = pRectangularRenderableObject ); Objects.assertNotNull( "RenderAccessor", mRenderAccessor = pRenderAccessor ); Objects.assertNotNull( "SizingApproach", mSizingApproach = pSizingApproach ); Objects.assertNotNull( "ParticipatingAdapter", mParticipatingAdapter = pParticipatingAdapter ); mIgnoreReportedSize = mIgnoreInitialNonParticipatingSize = (mDimensionAdapter = pDimensionAdapter).getInitialNonParticipatingSize(); mRROname = Objects.justClassName( pRectangularRenderableObject.getClass().getName() ); mDetermineRectSizeNow = new DetermineRectSizeNowRHP( mRROname, this ); if ( sTraceLogger == null ) { sTraceLogger = LOGGER.trace.isEnabled() ? RealTraceLogger.INSTANCE : NullTraceLogger.INSTANCE; } } protected Object getRectangularRenderableObject() { return mRectangularRenderableObject; } /** * @param pRequestedSize > 0 */ abstract protected RenderHelperProcess requestFloodSetSize( int pRequestedSize ); abstract protected RenderHelperProcess requestFloodAdjustSizeBy( int pRequestedSizeChange ); /** * @param pRequestedSize > 0 */ abstract protected RenderHelperProcess requestSetSize( int pRequestedSize ); abstract protected RenderHelperProcess requestAdjustSizeBy( int pRequestedSizeChange ); protected final void assertSizableAndAtLeastOne( String pWhat, int pSize ) { if ( pSize < 1 ) { throw new IllegalArgumentException( "Can Not " + pWhat + " '" + pSize + "', < 1 on: " + getRectangularRenderableObject() ); } assertSizable(); } protected final void assertSizable() { if ( !isSizable() ) { throw exceptionOnSizeChange(); } } protected UnsupportedOperationException exceptionOnSizeChange() { return new UnsupportedOperationException( "SizingApproach '" + mSizingApproach + // "' on: " + getRectangularRenderableObject() ); } public final boolean renderingParticipationChanged() { return chkForRenderingParticipationChanged(); } private boolean chkForRenderingParticipationChanged() { Boolean zNewParticipating = mParticipatingAdapter.isParticipatingInRendering( getRectangularRenderableObject() ); if ( zNewParticipating.equals( mParticipatingInRendering ) ) { return false; } mParticipatingInRendering = zNewParticipating; LLrenderingParticipationChanged(); return true; } /** * Clear Our State */ protected void LLrenderingParticipationChanged() { if ( mParticipatingInRendering ) { LLjustParticipatingInRendering(); } } protected void LLjustParticipatingInRendering() { mDetermineRectSizeNow.startingToParticipateInRendering(); layout(); } /** * Participating? (GWT attached & ! "Display=None") */ public final boolean isParticipatingInRendering() { chkForRenderingParticipationChanged(); return mParticipatingInRendering; } public final RenderSizingApproach getSizingApproach() { return mSizingApproach; } public boolean isSizable() { return !RenderSizingApproach.None.equals( mSizingApproach ); } public final RenderDimensionAdapter getDimensionAdapter() { return mDimensionAdapter; } public RenderHelper getParentHelper() { Object zParent = getDimensionAdapter().getParent( getRectangularRenderableObject() ); return (zParent != null) ? mRenderAccessor.getHelper( zParent ) : null; } /** * Restore the RenderableRect to its pre-Layed-out state and return the RenderHelper(s) for its children. * * @return !null array of the child RenderHelper(s) if any. */ public RenderHelper[] restoreForLayout() { LLrestoreForLayout(); return EMPTY_ARRAY; } /** * Restore the RenderableRect to its pre-Layed-out state. */ protected void LLrestoreForLayout() { mLayoutState = LayoutState.Restored; } /** * Return if this Helper is current in the Laying Out mode. */ public boolean isLayingOut() { return LayoutState.LayingOut.equals( mLayoutState ); } /** * Set the Helper to indicate that we are in the process of Laying Out. */ public void setLayingOut() { mLayoutState = LayoutState.LayingOut; } protected void setLayedOut() { mLayoutState = LayoutState.LayedOut; } protected boolean isLayedOut() { return LayoutState.LayedOut.equals( mLayoutState ); } /** * Request "this" RederableRect be invalidated from a layout perspective and that it and its related be layed out. * <p/> * Note: RHPs are Instance Equality Managed, so for the same underlying dependency the same RHP must be returned! * * @return null if no layout process is needed, * otherwise the returned RHP's callbacks will be notified when it is complete. */ public final RenderHelperProcess layout() { LLsetLayingOut(); if ( isLayoutAncestorHelper() ) { return layoutFromHereDown(); } return getParentHelper().layout(); } private void LLsetLayingOut() { if ( !this.isLayingOut() ) { RenderHelper[] zHelpers = prepForLayout( this ); if ( zHelpers.length != 0 ) { for ( Queue<RenderHelper[]> zLists = new LinkedList<RenderHelper[]>(); zHelpers != null; zHelpers = zLists.poll() ) { for ( RenderHelper zHelper : zHelpers ) { if ( !zHelper.isLayingOut() ) { RenderHelper[] zChildHelpers = prepForLayout( zHelper ); if ( zChildHelpers.length != 0 ) { zLists.offer( zChildHelpers ); } } } } } } } private RenderHelper[] prepForLayout( RenderHelper pHelper ) { RenderHelper[] zChildHelpers = pHelper.restoreForLayout(); pHelper.setLayingOut(); return zChildHelpers; } /** * Determine if this Helper is a Layout Ancestor. * <p/> * When going up the Parentage path, it will obviously return true at the root, but it may also return true at a Clipping Container that has been explicitly sized! */ public boolean isLayoutAncestorHelper() { return (getParentHelper() == null); } /** * Request that the "flood" Size be set to the pRequestedSize. * <p/> * It will not set the size below the Minimum. * <p/> * Note: RHPs are Instance Equality Managed, so for the same underlying dependency the same RHP must be returned! * * @param pRequestedSize - Must be > 0 * * @return !null RHP, where its callbacks will be notified when it is complete. * * @throws IllegalArgumentException if pRequestedSize <= 0 * @throws UnsupportedOperationException if the SizingApproach is "None" */ public RenderHelperProcess floodSetSize( int pRequestedSize ) throws IllegalArgumentException, UnsupportedOperationException { assertSizableAndAtLeastOne( "Flood Set Size to", pRequestedSize ); String zRequest = sTraceLogger.traceRequestSet( this, "floodSetSize", pRequestedSize ); RenderHelperProcess zProcess = requestFloodSetSize( pRequestedSize ); return sTraceLogger.traceCB( this, zRequest, zProcess ); } /** * Request that the "flood" Size be adjusted by pRequestedSizeChange. * <p/> * It will not set the size below the Minimum. * <p/> * Note: RHPs are Instance Equality Managed, so for the same underlying dependency the same RHP must be returned! * * @return !null RHP, where its callbacks will be notified when it is complete. * * @throws UnsupportedOperationException if the SizingApproach is "None" */ public RenderHelperProcess floodAdjustSizeBy( int pRequestedSizeChange ) throws UnsupportedOperationException { assertSizable(); String zRequest = sTraceLogger.traceRequestAdjust( this, "floodAdjustSizeBy", pRequestedSizeChange ); RenderHelperProcess zProcess = requestFloodAdjustSizeBy( pRequestedSizeChange ); return sTraceLogger.traceCB( this, zRequest, zProcess ); } /** * Request that the "user requested" Size be set to the pRequestedSize. * <p/> * It will not set the size below the Minimum. * <p/> * Note: RHPs are Instance Equality Managed, so for the same underlying dependency the same RHP must be returned! * * @param pRequestedSize - Must be > 0 * * @return !null RHP, where its callbacks will be notified when it is complete. * * @throws IllegalArgumentException if pRequestedSize <= 0 * @throws UnsupportedOperationException if the SizingApproach is "None" */ public RenderHelperProcess setSize( int pRequestedSize ) throws IllegalArgumentException, UnsupportedOperationException { assertSizableAndAtLeastOne( "Set Size to", pRequestedSize ); String zRequest = sTraceLogger.traceRequestSet( this, "setSize", pRequestedSize ); RenderHelperProcess zProcess = requestSetSize( pRequestedSize ); return sTraceLogger.traceCB( this, zRequest, zProcess ); } /** * Request that the "user requested" Size be adjusted by pRequestedSizeChange. * <p/> * It will not set the size below the Minimum. * <p/> * Note: RHPs are Instance Equality Managed, so for the same underlying dependency the same RHP must be returned! * * @return !null RHP, where its callbacks will be notified when it is complete. * * @throws UnsupportedOperationException if the SizingApproach is "None" */ public RenderHelperProcess adjustSizeBy( int pRequestedSizeChange ) throws UnsupportedOperationException { assertSizable(); String zRequest = sTraceLogger.traceRequestAdjust( this, "adjustSizeBy", pRequestedSizeChange ); RenderHelperProcess zProcess = requestAdjustSizeBy( pRequestedSizeChange ); return sTraceLogger.traceCB( this, zRequest, zProcess ); } protected final Integer getRectSizeNow() { if ( isParticipatingInRendering() ) { if ( mLastReportedSize != null ) { return mLastReportedSize; } int zSize = mDimensionAdapter.getSize( getRectangularRenderableObject() ); if ( (zSize != mIgnoreInitialNonParticipatingSize) && (zSize != mIgnoreReportedSize) ) { return (mLastReportedSize = zSize); } } return null; } protected void setSizingChange( int pCurrentSizeToIgnore, Integer pPendingNewSize ) { mIgnoreReportedSize = pCurrentSizeToIgnore; mLastReportedSize = null; } protected static RenderHelperProcess queue( RenderHelperProcess pProcess ) { return RenderProcessManager.INSTANCE.queue( pProcess ); } protected static void defer( RenderHelperProcess pProcessToDefer, int pForMillisecs ) { RenderProcessManager.INSTANCE.defer( pProcessToDefer, pForMillisecs ); } protected static void deferPending( AbstractRHPwithDependencies pDependentProcess, RenderHelperProcess pDependsOnProcess ) { if ( pDependentProcess != null ) { pDependentProcess.deferPending( pDependsOnProcess ); } } protected String toString( String pHelperName ) { return pHelperName + getDimensionAdapter().getWhat() + "-" + Objects.justClassName( getRectangularRenderableObject().getClass() ); } private interface TraceLogger { public String traceRequestSet( RenderHelper pRenderHelper, String pMethod, int pParam ); public String traceRequestAdjust( RenderHelper pRenderHelper, String pMethod, int pParam ); public RenderHelperProcess traceCB( RenderHelper pRenderHelper, String pRequest, RenderHelperProcess pHelperProcess ); } private static class NullTraceLogger implements TraceLogger { public static final TraceLogger INSTANCE = new NullTraceLogger(); public String traceRequestSet( RenderHelper pRenderHelper, String pMethod, int pParam ) { return null; } public String traceRequestAdjust( RenderHelper pRenderHelper, String pMethod, int pParam ) { return null; } public RenderHelperProcess traceCB( RenderHelper pRenderHelper, String pRequest, RenderHelperProcess pHelperProcess ) { return pHelperProcess; } } private static class RealTraceLogger implements TraceLogger { public static final TraceLogger INSTANCE = new RealTraceLogger(); private static int sTraceInstance = 0; public String traceRequestSet( RenderHelper pRenderHelper, String pMethod, int pParam ) { return LLtraceRequest( pRenderHelper, pMethod, Integer.toString( pParam ) ); } public String traceRequestAdjust( RenderHelper pRenderHelper, String pMethod, int pParam ) { Integer zCurrentSize = pRenderHelper.getCurrentSize(); Integer zExpectedSize = (zCurrentSize != null) ? (zCurrentSize + pParam) : null; return LLtraceRequest( pRenderHelper, pMethod, "" + pParam + " + " + zCurrentSize + " = " + zExpectedSize ); } private String LLtraceRequest( RenderHelper pRenderHelper, String pMethod, String pParam ) { String zRequest = "" + (++sTraceInstance) + "|" + pRenderHelper + ": " + // pMethod + "( " + pParam + " )"; LOGGER.trace.log( zRequest, "..." ); return zRequest; } public RenderHelperProcess traceCB( RenderHelper pRenderHelper, String pRequest, RenderHelperProcess pHelperProcess ) { if ( pHelperProcess == null ) { LOGGER.trace.log( pRequest, "!" ); } else { pHelperProcess.addCallback( new TraceCallBack( pRenderHelper, pRequest ) ); } return pHelperProcess; } } private static class TraceCallBack implements RenderHelperCallback { private RenderHelper mRenderHelper; private String mRequest; public TraceCallBack( RenderHelper pRenderHelper, String pRequest ) { mRenderHelper = pRenderHelper; mRequest = pRequest; } public void processCompleted( RenderHelperProcess pCompletedProcess, RenderProcessResult pCompletedProcessResult ) { LOGGER.trace.log( mRequest, // " -> ", mRenderHelper.getCurrentSize(), // " (min:", mRenderHelper.getMinimumSize(), // " | ", // mRenderHelper.getNaturalSize(), ":nat) ", // pCompletedProcessResult ); } } } |