| Package | com.yworks.graph.model |
| Class | public class StripeSubregion |
| Inheritance | StripeSubregion  Object |
| Implements | IEnum |
IStripe instance.
See also
| Property | Defined By | ||
|---|---|---|---|
| value : Number [read-only] | StripeSubregion | ||
| Method | Defined By | ||
|---|---|---|---|
StripeSubregion(value:Number)
Must not be used. | StripeSubregion | ||
combine(... toCombine):StripeSubregion [static]
Returns a SubRegion instance which is a combination of the given parameter list. | StripeSubregion | ||
hits(other:StripeSubregion):Boolean
Whether this subregion has common parts with the given other subregion. | StripeSubregion | ||
toString():String | StripeSubregion | ||
| Constant | Defined By | ||
|---|---|---|---|
| ALL : StripeSubregion [static]
Flag for all stripe regions. | StripeSubregion | ||
| FAR_BORDER : StripeSubregion [static]
Flag for the stripe far border region. | StripeSubregion | ||
| HEADER : StripeSubregion [static]
Flag for both stripe headers. | StripeSubregion | ||
| LEADING_HEADER : StripeSubregion [static]
Flag for the leading stripe header. | StripeSubregion | ||
| NEAR_BORDER : StripeSubregion [static]
Flag for the stripe near border region. | StripeSubregion | ||
| NONE : StripeSubregion [static]
No active hotspot region
| StripeSubregion | ||
| STRIPE : StripeSubregion [static]
Flag for the stripe itself. | StripeSubregion | ||
| TRAILING_HEADER : StripeSubregion [static]
Flag for the trailing stripe header. | StripeSubregion | ||
| value | property |
value:Number [read-only] public function get value():Number| StripeSubregion | () | Constructor |
public function StripeSubregion(value:Number)Must not be used.
Use the enum constants instead. To create a combination of two or more constants
use the combine() method.
value:Number |
See also
| combine | () | method |
public static function combine(... toCombine):StripeSubregion
Returns a SubRegion instance which is a combination of the given parameter list.
Example:
var header:StripeSubregion = StripeSubregion.combine(StripeSubregion.LEADING_HEADER, StripeSubregion.TRAILING_HEADER);
combines the header subregions. (Note that the resulting subregion is equal to StripeSubregion.HEADER.
To test whether a subregion lies within the range which is defined by such a combination
the method hits() can be used.
Parameters
... toCombine — A list of the subregions to combine.
|
StripeSubregion — A StripeSubregion instance which represents the combined subregions.
|
See also
| hits | () | method |
public function hits(other:StripeSubregion):BooleanWhether this subregion has common parts with the given other subregion.
For example:
StripeSubregion.HEADER.hits(StripeSubregion.LEADING_HEADER) == trueStripeSubregion.LEADING_HEADER.hits(StripeSubregion.HEADER) == trueStripeSubregion.HEADER.hits(StripeSubregion.NEAR_BORDER) == falseParameters
other:StripeSubregion |
Boolean —
|
See also
| toString | () | method |
public function toString():StringReturnsString |
| ALL | Constant |
public static const ALL:StripeSubregionFlag for all stripe regions.
A bitwise combination of all enum values.
| FAR_BORDER | Constant |
| HEADER | Constant |
| LEADING_HEADER | Constant |
| NEAR_BORDER | Constant |
| NONE | Constant |
public static const NONE:StripeSubregionNo active hotspot region
| STRIPE | Constant |
| TRAILING_HEADER | Constant |