Compile Time Changes
cm/win/winPainter.cm - Old: extend public sorted str->str getPainterData() + New: extend public str->Object inspectorData() cm/win/window.cm - Old: extend public sorted str->str getPainterData() + New: extend public str->Object inspectorData()
Change of setImage method in Control
We have revised argument update to resize while adding a new argument refresh to control repaints. This is a far reaching change, affecting over 88 files in the base repo.
Old: extend public void setImage(Image image, bool update=true) { New: extend public void setImage(Image image, bool resize, bool refresh) {
Changes to DoubleScrollBar affecting TreeView
We have introduced a new argument bool transparentBG defaulting to false. This argument allows us to draw scrollbars in an experiemntal way that is transparent.
Old: public constructor(Window parent, bool showStepButtons=false, bool slim=false) { New: public constructor(Window parent, bool showStepButtons=false, bool slim=false, bool transparentBG=false) {
This is also exposed in TreeView's createDoubleScrollBar method:
Old: extend public DoubleScrollBar createDoubleScrollBar() { New: extend public DoubleScrollBar createDoubleScrollBar(bool transparentBG=false) {
TreeView's constructor also exposes this functionality with the bool transparentScrollBars argument.
Old: public constructor(Window parent, // inherited key arguments Font font=systemFont(), Brush brush=null, FrameStyle frameStyle=stdLightFrame, frame3DState frameState=frameStateDown, pointI pos=(0, 0), sizeI size=(100, 100), pointI margins=(2, 2), alignment align=middle, bool popup=false, bool shadow=false, function (Control control) callback=null, // extended key arguments bool alwaysMultiSelect=false, bool allowMultiSelect=false, bool directSelect=false, bool listBoxStyle=false, treeViewSelectionStyle selectionStyle=treeViewSelectionStyle.undefined, function (Control control) click2Callback=null, bool noScrollBars=false, str key=null, SrcRef src=#:src) { New: public constructor(Window parent, // inherited key arguments Font font=systemFont(), Brush brush=null, FrameStyle frameStyle=stdLightFrame, frame3DState frameState=frameStateDown, pointI pos=(0, 0), sizeI size=(100, 100), pointI margins=(2, 2), alignment align=middle, bool popup=false, bool shadow=false, function (Control control) callback=null, // extended key arguments bool alwaysMultiSelect=false, bool allowMultiSelect=false, bool directSelect=false, bool listBoxStyle=false, treeViewSelectionStyle selectionStyle=treeViewSelectionStyle.undefined, function (Control control) click2Callback=null, bool transparentScrollBars=false, bool noScrollBars=false, str key=null, SrcRef src=#:src) {
Visbility of fields in ViewItemColorButton
Privatized a member and added setters/getters.
Old: public color _color; New: private color _color; New: extend public color color() { New: extend public void setColor(color c) {
Removal of LegacyFrame and related functions
As an ongoing effort of modernizing cm.win, we have removed a few more key classes in this release.
The following methods have been removed from Window:
Removed: final public void setFrameOLD(frame3DStyle oldStyle, frame3DState state) : deprecated { // OLD Removed: final public void setFrameStyleOLD(frame3DStyle oldStyle) : deprecated { Old: extend public void eraseFrame() { New: extend public void refreshFrame() {
The field frame3DStyle oldStyle and related methods have been removed from WinFrame:
Removed: public frame3DStyle oldStyle; Removed: final public void setOldStyle(frame3DStyle fstyle) { Removed: final public void drawFrameOLD(PixelDevice d, rectI r) { Removed: final public void invalidateFrame(Window parent, bool rightDownOnly=true) { Removed: final public void invalidateFrame(Window parent, sizeI r, bool rightDownOnly=true) { Removed: final public void drawFramePoly(PixelDevice d, PolylineI poly, color c) { Old: public constructor(frame3DStyle oldStyle, frame3DState state) { New: public constructor(FrameStyle style, frame3DState state) {
With these changes, LegacyFrame has no more purpose and has been removed.
Removed: public class LegacyFrame extends FrameStyle {
Constructor changes to StateControlGroup
Argument bool allowReselect with a default value of false has added to the constructor.
Old: public constructor(function(Control c) callback=null, // extends arguments bool exclusiveChoice=true, bool noSelectionPossible=false) { New: public constructor(function(Control c) callback=null, // extends arguments bool exclusiveChoice=true, bool noSelectionPossible=false, bool allowReselect=false) {
Constructor changes to LinkButton
Argument bool showUnderline with a default value of false has been added to control the underline state.
Old: public constructor(Window parent, Font font=underlineSystemFont, Brush brush=null, FrameStyle frameStyle=noFrame, str label="", color labelColor=color(0, 0, 240), alignment textSide=undefinedAlignment, Image image=null, Image disabledImage=null, color color=nocolor, sizeI size=(-1, -1), pointI margins=(0, 0), alignment align=middle, str link=null, function(Control button) callback=null, SrcRef src=#:src) { New: public constructor(Window parent, Font font=underlineSystemFont, Brush brush=null, FrameStyle frameStyle=noFrame, str label="", color labelColor=color(0, 0, 240), alignment textSide=undefinedAlignment, Image image=null, Image disabledImage=null, color color=nocolor, sizeI size=(-1, -1), pointI margins=(0, 0), alignment align=middle, str link=null, bool showUnderline=false, function(Control button) callback=null, SrcRef src=#:src) {
Changes to ScrollableSubWindow
We have added arguments str key, bool faceliftScrollBars, bool transparentScrollBars to ScrollableSubWindow's constructor. This allows the caller to specify some additional scroll bar parameters.
Old: public constructor(Window parent, bool verticalBar=true, bool horizontalBar=true, // inherited key arguments. Font font=systemFont(), Brush brush=null, FrameStyle frameStyle=thick3DFrame, frame3DState frameState=frameStateDown, pointI origin=(1, 1), bool selectable=true, pointI pos=(0, 0), sizeI size=(0, 0), bool passive=false, bool handScrollX=true, bool handScrollY=true, bool slimScrollBars=false, bool showStepButtons=false, str scrollPosId=null, SrcRef src=#:src) { New: public constructor(Window parent, bool verticalBar=true, bool horizontalBar=true, // inherited key arguments. Font font=systemFont(), Brush brush=null, FrameStyle frameStyle=thick3DFrame, frame3DState frameState=frameStateDown, pointI origin=(1, 1), bool selectable=true, pointI pos=(0, 0), sizeI size=(0, 0), bool passive=false, str key=null, // extended key arguments. bool handScrollX=true, bool handScrollY=true, bool slimScrollBars=false, bool faceliftScrollBars=false, bool transparentScrollBars=false, bool showStepButtons=false, str scrollPosId=null, SrcRef src=#:src) {
The init scroll methods have also been revised, taking in two additional arguments bool faceliftScrollBars, bool transparentScrollBars, both defaulting to false.
Old: extend public ScrollBar initVScroll(sizeI sz, bool showStepButtons) { New: extend public ScrollBar initVScroll(sizeI sz, bool showStepButtons, bool faceliftScrollBars=false, bool transparentScrollBars=false) { Old: extend public ScrollBar initHScroll(sizeI sz, bool showStepButtons) { New: extend public ScrollBar initHScroll(sizeI sz, bool showStepButtons, bool faceliftScrollBars=false, bool transparentScrollBars=false) {
Removal of ScrollableSubWindowWithKey
Due to the addition of str key argument into ScrollableSubWindow, there is no purpose for ScrollableSubWindowWithKey and it has been removed
Removed: public class ScrollableSubWindowWithKey extends ScrollableSubWindow {
Removal of truncateWithEllipsis
Over the years, various efforts were made to unify the way texts were shortened. Calls to the deprecated truncateWithEllipsis should be replaced with shortenText.
Old: public str truncateWithEllipsis(str text, Font font, int width) : deprecated { New: public str shortenText(str text, Font font, int width) {
Small changes to winApi
A new argument bool windows11 has been added.
Old: public void configureCustomCaptionWindow(mwnd m, lparam lParam) = win_configureCustomCaptionWindow; New: public void configureCustomCaptionWindow(mwnd m, lparam lParam, bool windows11) = win_configureCustomCaptionWindow;
Cleanup of ModalDialog
The following unused fields and methods are removed from ModalDialog
Removed: public Window{} previouslyDisabled; Removed: final public void enablePreviouslyDisabled() {
Move of DebugDialog
This dialog is used by cm.core.debug, so it has been moved to that package.
Removal of PreITreeView
This class was previously used by Window Inspector to perform double buffered repainting pre 15.0. As of 15.0, TreeView has its own method of double buffered, so this class has been redundant and removed.
Removed: public class PreITreeView extends TreeView {
Correct passing of callerLoc into FrameWindow
We have added an argument str loc defaulting to callerLoc() to contructors of FrameWindow subclasses. This makes it easier to figure out which the call site of a constructed FrameWindow. Useful to identify the call site of a ModalDialog / message boxes.
# AppWindow Old: public constructor(str label="Configura Virtual Machine", // inherited key arguments Font font=systemFont, Brush brush=null, pointI origin=(0, 0), pointI pos=(0, 0), sizeI size=(300, 200), bool initVisible=true, bool noMinimize=false, bool noMaximize=false, // extended key arguments str name=null, Window appWinAsDialogParent=null) { New: public constructor(str label="Configura Virtual Machine", // inherited key arguments Font font=systemFont, Brush brush=null, pointI origin=(0, 0), pointI pos=(0, 0), sizeI size=(300, 200), bool initVisible=true, bool noMinimize=false, bool noMaximize=false, // extended key arguments str name=null, Window appWinAsDialogParent=null, str loc=callerLoc()) { Old: public constructor(TitleBarConfig tbConfig, str label="Configura Virtual Machine", // inherited key arguments Font font=systemFont, Brush brush=null, pointI origin=(0, 0), pointI pos=(0, 0), sizeI size=(300, 200), bool initVisible=true, // extended key arguments str name=null, Window appWinAsDialogParent=null) { New: public constructor(TitleBarConfig tbConfig, str label="Configura Virtual Machine", // inherited key arguments Font font=systemFont, Brush brush=null, pointI origin=(0, 0), pointI pos=(0, 0), sizeI size=(300, 200), bool initVisible=true, // extended key arguments str name=null, Window appWinAsDialogParent=null, str loc=callerLoc()) { Old: package constructor(bool noBorder, bool noCaptionStyle, bool shadow=false, // Same as above str label="CustomCaption", Font font=systemFont, Brush brush=null, pointI origin=(0, 0), pointI pos=(0, 0), sizeI size=(300, 200), bool initVisible=true, bool noMinimize=false, bool noMaximize=false, str name=null) { New: package constructor(bool noBorder, bool noCaptionStyle, bool shadow=false, // Same as above str label="CustomCaption", Font font=systemFont, Brush brush=null, pointI origin=(0, 0), pointI pos=(0, 0), sizeI size=(300, 200), bool initVisible=true, bool noMinimize=false, bool noMaximize=false, str name=null, str loc=callerLoc()) {
# FormattedTextMessageBox Old: public constructor(Window parent, str header, FormattedText content, Font font=systemFont(), Brush brush=null, pointI origin=(0, 0), bool selectable=true, str label="Message", pointI pos=(-1, -1), sizeI size=(280, 80), bool framed=false, bool initVisible=true, bool readOnly=true) { New: public constructor(Window parent, str header, FormattedText content, Font font=systemFont(), Brush brush=null, pointI origin=(0, 0), bool selectable=true, str label="Message", pointI pos=(-1, -1), sizeI size=(280, 80), bool framed=false, bool initVisible=true, bool readOnly=true, str loc=callerLoc()) { Old: public void makeFormattedTextMessageBox(Window parent, str message, FormattedText content, bool framed=false, bool readOnly=true) { New: public void makeFormattedTextMessageBox(Window parent, str message, FormattedText content, bool framed=false, bool readOnly=true, str loc=callerLoc()) { Old: public void makeFormattedTextMessageBox(Window parent, str label, str message, FormattedText content, bool framed=false, bool readOnly=true) { New: public void makeFormattedTextMessageBox(Window parent, str label, str message, FormattedText content, bool framed=false, bool readOnly=true, str loc=callerLoc()) {
# OneButtonBox Old: public constructor(Window parent, str message, Font font=systemFont(), Brush brush=null, pointI origin=(0, 0), bool selectable=true, str label=$messageDialogCaption, pointI pos=(-1, -1), sizeI size=(280, 80), bool initVisible=true) { New: public constructor(Window parent, str message, Font font=systemFont(), Brush brush=null, pointI origin=(0, 0), bool selectable=true, str label=$messageDialogCaption, pointI pos=(-1, -1), sizeI size=(280, 80), bool initVisible=true, str loc=callerLoc()) {
Runtime/Behavior Changes
cm/win/control.cm = setLabel(str label, bool update=true) now calls setFont to ensure the correct font is propagated to the winPainter. cm/win/display.cm + Added: final public void setLabelAndTruncate(str label, int maxW, int maxWrap, bool update=true) {
Alternate email creation interface
Existing email interfaces uses MAPI which is not currently supported by the new Outlook app. We have added new interfaces that uses .eml files instead:
public bool createEmail(str subject, str text, str[] to, str[] cc=null, Url[] attachments=null, Url path=null, bool open=true) public bool createEmail(str subject, str text, str to, str[] cc=null, Url[] attachments=null, Url path=null, bool open=true) public bool createEmail(str subject, str text, str->Object args, Url path=null, bool open=true) public bool createEmail(str subject, str text, str->Object args, bool open=true)
Automatic saving of size and position of FrameWindow
Improvements have been made to how we store and restore window position and sizes.
- Some preliminary multi monitor support
- Restoring of maximized state
- Ignore position / bound for snapped / arranged windows
To opt-in to this, your dialog has to override these methods:
/** * Auto save position or size? */ public bool autoSavePos() { return true; } public bool autoSaveSize() { return true; }
Resizing improvements
Previously, most FrameDialogs required to override resizing1 in order for childWindows that are not inside a SubWindow to reposition and resize correctly. This is no longer required, as we have moved some resizing logic from SubWindow to Window.
# SubWindow public void ancestorResizing() { Removed: redoLastPosition(); Removed: redoLastSize(); super(); refreshFrame(); } # Window extend public void ancestorResizing() { Added: redoLastPosition(); Added: redoLastSize(); for (c in _childWindows) { if (!c.visible) continue; if (c in PaneContainer) continue; c.ancestorResizing(); } // Second pass to process PaneContainer. for (c in _childWindows) { if (!c.visible) continue; if (c !in PaneContainer) continue; c.ancestorResizing(); } }
Miscellaneous
Deprecation of Old UI
The old UI in CET is now deprecated and enters maintenance support period. This implies the following:
- New UI is now the default UX for all users.
- The toggle to switch over to old UI is now removed by default.
- No more feature / enchancements will be done for old UI.
- Only critical / blocking issues for old UI will be fixed.
- Issue will not be fixed if issue is not reproducible in new UI.
- Code for old UI persists until 17.0, and unused components will be deprecated moving forward.