votorola.s.gwt.mediawiki

Class DifferenceShadowsV

java.lang.Object

DifferenceShadowsV

final class DifferenceShadowsV
extends Object

A view of difference shadows for MediaWiki draft pages. It shows a single difference at a time, whichever is currently lit by the shadow light. The view includes a top bridge box (t) composed of a bridge link ] [ and a segment counter.

                              (t)-- ] [  +-----------+  +------------+  +--
                                \        | user page |  | discussion |  |
                                 \   +---+           +--+------------+--+--
        +------------------------ \  |
        |                          \
        |                         |  3
        |                         |  v
        |        w i k i          |                 (showing Monobook skin,
        |                         |  |                 Vector is similar)
        |        l o g o          |  |
        |                         |  |
        |       i m a g e         |  |
        |                         |  |
        |                         |  |
        |                         |  |
        +-------------------------+  |
                                     |
                                    ]|[          ###########
                                     |
                                     |
                                     |        (s)
                                     |
                                     |
                                    ]|[         ###########################
                                     |   ##################################
                                     |   ##############
                                     |
                                    ]|[                        ########
                                     |
                                     |

The shadow (s) is projected underneath the text of the author's draft in those regions (segments ###) where it differs from the other person's draft. Each shadow segment is accompanied by a bridge link ] [ targeting that particular segment of the difference.

Page parameters

The following parameters are defined for a shadowed page in addition to those already defined by MediaWiki.

Key	Value	Default
rep	The debug reporting threshold.	0
rep_diff_user	Filters difference related debug reports by the username of the other drafter.	Null, optional item.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	DifferenceShadowsV.BridgeBox A box of controls (t or s) that is shown for the shadowed difference currently lit by the shadow light.
(package private) static class	DifferenceShadowsV.TopBox The topmost bridge box (t).
(package private) static class	DifferenceShadowsV.Warning Thrown when a failure is detected that ought to be shown to the user.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SRC_DIFF The source URL of the image for links to difference segments.
static String	SRC_DIFF_DISABLED The source URL of the image for disabled links to difference segments.

Constructor Summary

Constructors

Constructor and Description
DifferenceShadowsV(DifferenceShadows _shadows, Stage stage) Constructs a DifferenceShadowsV for init to finish.

Method Summary

Methods

Modifier and Type	Method and Description
(package private) void	init() Completes the construction of the DifferenceShadowsV.
(package private) int	rep() The debug reporting threshold as requested by the rep page parameter.
(package private) void	report(String message, int level) Shows a debug report to the user.
(package private) void	report(String message, int level, ShadowedDiff diff) Shows a debug report to the user that may be filtered by difference properties.
(package private) DifferenceShadowsV.TopBox	topBox() The topmost bridge box (t).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SRC_DIFF

public static final String SRC_DIFF

The source URL of the image for links to difference segments.

SRC_DIFF_DISABLED

public static final String SRC_DIFF_DISABLED

The source URL of the image for disabled links to difference segments.

Constructor Detail

DifferenceShadowsV

DifferenceShadowsV(DifferenceShadows _shadows,
                  Stage stage)

Constructs a DifferenceShadowsV for init to finish. It will co-exist permanently with the stage.

Method Detail

init

void init()
    throws DifferenceShadowsV.Warning

Completes the construction of the DifferenceShadowsV. Call once only.

Throws:

Warning - if a failure is detected that ought to be reported to the user.

DifferenceShadowsV.Warning

report

void report(String message,
          int level)

Shows a debug report to the user. The report is shown as stage warnings when the view runs in production mode, otherwise it is printed to the console.

Parameters:

level - the detail level of the message, 1 or higher.

See Also:

rep()

rep

int rep()

The debug reporting threshold as requested by the rep page parameter. A level of zero (0) disables reporting entirely. Levels of 1 or higher enable progressively more detailed messages to be reported.

See Also:

report(String,int)

report

void report(String message,
          int level,
          ShadowedDiff diff)

Shows a debug report to the user that may be filtered by difference properties.

Parameters:

level - the detail level of the message, 1 or higher.

diff - the argument for any rep_diff_user filter.

topBox

DifferenceShadowsV.TopBox topBox()

The topmost bridge box (t).