Page Comparison

...

...

Using Parameters In Macros

Macros provide a way to associate a name with a group of valid Nexaweb page instructions (XUpdate, MCO, data, and so forth) that the Nexaweb platform loads into memory and executes at any time.

Nexaweb 4.2.x now allows you to use java.text.MessageFormat syntax to specify parameters in macros that execute logic, thus allowing macros to accept arguments. MessageFormat syntax allows you to specify where arguments go and the format of those arguments (such as a number format that includes comma separation, dollar signs, and so forth.)  The use of parameters in macros increases each macro's flexiblity, since you can now re-use each macro to act on a varying list of components. For example, with the use of parameters, you can write one macro to close two different windows rather than writing two separate macros (without parameters) to close those windows.

When used to develop client side logic, macros provide the following benefits:

• Using the same XML-based tools that you use to develop your client UI
• No roundtrips to the server required
• Portability for future Nexaweb client environments

The following example shows use of a macro that does not use parameters:

...

• クライアント UI の開発に使用される XML ベースのツールが使用できる
• サーバーへの往復が不要になる
• 将来の Nexaweb クライアント環境への移植性がある

<modifications document="nxml">
<remove select="id(

‘‘MyWindow’’)">
</modifications>

The following example shows use of a macro with parameters:

Macro:

<modifications document="nxml">
             ”nxml”>
<remove select="id(''{0}'')">
 </modifications>

onCommand=

...

”macro://mymacro.execute (‘Window1’) 

Defining Macros Overview

The following shows the basic format for defining macros:

...

When defining macros keep in mind the following: 

...

• マクロの名前は固有でなければなりません。新しいマクロを既存のマクロと同じ名前で作成すると、新しく作成されたマクロは古いマクロを上書きします。
• Nexaweb は、マクロにインクルードする Nexaweb ページの命令をすべて文字列に変換し、java.text.message フォーマットを使用してフォーマット処理を行います。したがって、マクロ内の Nexaweb ページの命令は java.text.message format syntax, for example, to conform to javaフォーマットのシンタックスに準拠している必要があります。たとえば、java.text.message format syntax, you must escape single ticks and curly brackets in your Nexaweb page instructions.

Defining Macro XUpdate Commands Without Parameters

The following example shows a page containing a macro with an XUpdate command that does not use parameters.

...

• フォーマットのシンタックスに準拠するには、Nexaweb ページの命令に一重引用符と中かっこを使用してエスケープする必要があります。

<nxml>

<macro:macro name="mymacro" xmlns:macro="http://nexaweb.com/macro">

<xu:modifications xmlns:xu="http://nexaweb.com/xupdate">

<xu:set-attribute select="id(''mylabel'')">

<xu:attribute name="text" value="New Text" />

</xu:set-attribute>

</xu:modifications>

</macro:macro>

<panel>

<flowLayout align="center"/>

<label text="Old Text" id="mylabel" bgcolor="green"/>

<button text="Execute Macro" onCommand="macro://mymacro.execute()"/>

</panel>

</nxml>

Defining Macro XUpdate Commands With Parameters

...

<macro:macro name="mydialog" xmlns:macro="http://nexaweb.com/macro">

<xu:modifications document="nxml" xmlns:xu="http://nexaweb.com/xupdate">

<xu:append select="/nxml/rootPane">

<dialog title="My Dialog" closeable="false" focused="true" centered="true">

<label text="My dialog is your dialog, from California, to the New York islands"/>

</dialog>

</xu:append>

</xu:modifications>

</macro:macro>
<macro:macro name="generic-dialog" xmlns:macro="http://nexaweb.com/macro">

<xu:modifications document="nxml" xmlns:xu="http://nexaweb.com/xupdate">

<xu:append select="/nxml/rootPane">

<dialog title="{0}" closeable="{1}" focused="{2}" centered="{3}">

<label text="{4}"/>

</dialog>

</xu:append>

</xu:modifications>

</macro:macro>

...

<macro:macroCall name="generic-dialog"

xmlns:macro="http://nexaweb.com/macro" >

<macro:parameter>ThisIt</macro:parameter>

<macro:parameter>true</macro:parameter>

<macro:parameter>true</macro:parameter>

<macro:parameter>false</macro:parameter>

<macro:parameter>Answer</macro:parameter>

</macro:macroCall>

MacroContainer macroContainer = ClientSession.getMacroContainer();

Macro macro = macroContainer.createMacro

("<xu:modifications xmlns:xu=\"http://nexaweb.com/xupdate\" document=\"nxml\">" +

" <xu:append select=\"/nxml/rootPane[1]\">" +

" <dialog>" +

" <label text=\"Call me Ishmael.

Some years ago- never mind how long precisely...\" />" +
  

" </dialog>" +

  " </xu:append>" +

  "</xu:modifications>" );

macroContainer.putMacro("nexaweb-examples-herman-melville-dialog", macro);

MacroContainer macroContainer = clientSession.getMacroContainer();

Macro melvilleMacro = macroContainer.getMacro( "nexaweb-examples-herman-melville-dialog" );

melvilleMacro.execute();

Macro genericXUpdateMacro = macroContainer.getMacro( "nexaweb-examples-generic-xupdate" );

genericXUpdateMacro.execute( new Object [] { "remove-element", "id('anElementId')", "" } );

genericXUpdateMacro.execute( new Object [] { "append",

 "/nxml/rootPane[1]", "<dialog><label

 text=\"Mylabel\"/></dialog>" } );

<log-configuration>

<log name="Macro" log-level="debug"/>

</log-configuration>

[Debug - 10:42:22 (Macro): Enabled debug logging.]

[Debug - 10:42:35 (Macro): Formatting macro with 0 args: []]

[Debug - 10:42:35 (Macro): Macro pre-formatting:

<nxml><xu:modifications xmlns:xu="http://nexaweb.com/xupdate" document="nxml">

<xu:append select="/nxml/rootPane[1]">

<dialog>

<label text="Call me Ishmael. Some years ago- never mind how long precisely..."/>

</dialog>

</xu:append>

</xu:modifications></nxml>]

[Debug - 10:42:35 (Macro): Macro post-formatting:

<nxml>

<xu:modifications xmlns:xu="http://nexaweb.com/xupdate" document="nxml">

<xu:append select="/nxml/rootPane[1]">

<dialog>

<label text="Call me Ishmael. Some years ago- never mind how long precisely..."/>

</dialog>

</xu:append>

</xu:modifications>

</nxml>]

[Debug - 10:42:46 (Macro): Formatting macro with 3 args: ["append", 

"/nxml/rootPane[1]", "<dialog><label text="Mylabel" 

/></dialog>"]]

[Debug - 10:42:46 (Macro): Macro pre-formatting:

<nxml>

<xu:modifications document="nxml" xmlns:xu="http://nexaweb.com/xupdate" >

<xu:{0} select="{1}" >

{2}

</xu:{0}>

</xu:modifications>

</nxml>]

[Debug - 10:42:46 (Macro): Macro post-formatting:

<nxml>

<xu:modifications document="nxml" xmlns:xu="http://nexaweb.com/xupdate" >

<xu:append select="/nxml/rootPane[1]" >

<dialog><label text="Mylabel" /></dialog>

</xu:append>

</xu:modifications>

</nxml>]

<!-- This parameter is supplied so that the macro code can know NOT -->
<!-- to use MessageFormat for the macro strings. in 4.2 we added parameters -->
<!-- which use MessageFormat, thus single tick escaping is required in 4.2 -->
<!-- plus. We want existing macros to work if the customer so desires. -->
<ensure-pre-4-dot-2-macro-compatibility>false</ensure-pre-4-dot-2-macro-compatibility>

onCommand=

”macro://mymacro.execute (‘Window2’)"