<@doc hierarchy="GMLDOM">
   An element used for referencing a scenario unit.

   <copyright>(c) SAP AG 2003-2006. All rights reserved.</copyright>
</doc@>

#INCLUDE[svg:defs.inc]


///////////////////////////////////////////////////////////////////////
// CLASS HEADER

Class ScenarioUsage inherit ComponentUsage;
attach ScenarioUsageLayout;

metadata title  = '#TEXT[XTIT_SCENARIO_USAGE]';
metadata descr  = '#TEXT[XTOL_SCENARIO_USAGE]';
metadata icon16 = '#URL[~res:skins.neutral.symbols.scenarioUsage16.gif]';
metadata icon32 = '#URL[~res:skins.neutral.symbols.scenario32.gif]';

attach svg:Bipolar override {
   fillColor:    '#F2F5F8',
   strokeColor:  '#6183A9',
   textColor:    '#6183A9',

   geometry: {
      resizeMode: #[SVG_KEEP_WIDTH],
      rotateMode: #[SVG_ROTATE_FULL|SVG_FLIP_VBODY],
      defWidth:   85,
      defHeight:  65,
      minWidth:   85,
      minHeight:  65,
      poleStart:  20,
      poleEnd:    20,
      padding:    [0,10,0,10]
   },

   frameParts: [
      {type:'rect', x:'@x1', y:'@y1', width:'@w', height:'@h', rx:0, fill:'@fillColor', stroke:'currentColor', 'stroke-width':2}

   ],

   bodyParts: [
      {type:'text',  action:'rename', text:'((@name).length > $ENV.maxNameLength ? (@name).substring(0,$ENV.maxNameLength)+"..." : @name )', x:0, y:'@y1+12', 'font-size':'90%', fill:'@textColor', stroke:'none', 'text-anchor':'middle'},
      {type:'text',  text:'(@tags ? "<<"+@tags+">>" : "")', x:0, y:'@y2-5', 'font-size':'75%', fill:'@textColor', 'text-anchor':'middle'},
      {type:'image', href:'#URL[svg~skin:images.shortcut.gif]', display:'(@isPrimary  ? "none" :  "block"  )', x:'@x1+4', y:'@y2-15', width:11, height:11, sprite:false}
   ]
}


///////////////////////////////////////////////////////////////////////
// PROPERTIES

<@doc>Position, in format 'X Y', of this object in its parent UI container, in parent client coordinates.</doc@>
property pos = '0 0';

<@doc>Size, in format 'W H', of this object on the screen.</doc@>
property size = '320 240';

<@doc>Defines the index of this object in its parent object layout calculation.</doc@>
property index = 0;

<@doc>Specifies if this object is drawn in the Layout Board. Design-time only.</doc@>
readonly property showInLayout = true;

<@doc>Defines interactor's toolbar, if any.</doc@>
strong property toolbar = ^Toolbar;

<@doc>Indicates whether to show the title bar, if applicable</doc@>
property showTitlebar = false;

<@doc>
   Indicates whether to show the toolbar, if applicable
   <remarks>
      Event if this property is ~false, the @toolbar property can have valid toolbar defintion.
      In such case, the toolbar will not be displayed.
   </remarks>
</doc@>
property showToolbar = false;

<@doc>Indicates whether to show the paging bar, if applicable</doc@>
property showPagingbar = false;

<@doc>Column Layout specific. Gets or sets element's colspan</doc@>
property colspan = 3;


///////////////////////////////////////////////////////////////////////
// METHODS

override method onCreate()
   this.supercall();
   this.createElement('core.gml:DirectPlug', 'plugs');
   this.createElement('core.gml:Toolbar', 'toolbar');
end

<@doc>
Returns an array representing all the events published or consumed by this element
   <param name="dir" type="@Plug!DIRECTIONS">Specify incoming or outgoing events</param>
   <return type="string[]">An array of event names</return>
</doc@>
override method getEvents(dir)
   return (this.getTarget() && this.getTarget().getEvents(dir)) || [];
end

<@doc>
   Check if the object has personalization implications
   <return type="b">~true if it does has personalization implications, ~false otherwise</return>
</doc@>
override method canBePersonalized()
	return(true); // This Class can be personalized in RT by the end user (ByD application user)
end