| Package | impression.persistence.properties |
| Class | public class RelativeLocations |
| Inheritance | RelativeLocations  Object |
| Method | Defined By | ||
|---|---|---|---|
isRelativeLocation(locationName:String):Boolean [static]
Determines if the passed in locationName is one of the defined constants. | RelativeLocations | ||
| Constant | Defined By | ||
|---|---|---|---|
| CURRENT : String = _current [static]
The current location. | RelativeLocations | ||
| CURRENT_MAP : String [static]
The current map. | RelativeLocations | ||
| DEFAULT_MAP : String = _default [static]
The default map. | RelativeLocations | ||
| FIRST_CHILD : String = _firstChild [static]
The first child of the current location, or null if the current location has no children. | RelativeLocations | ||
| FIRST_SIBLING : String = _firstSibling [static]
The first sibling of the current location. | RelativeLocations | ||
| FIRST_STORYBOARD : String = _firstStoryboard [static]
The first storyboard. | RelativeLocations | ||
| LAST_CHILD : String = _lastChild [static]
The last child of the current location, or null if the current location has no children. | RelativeLocations | ||
| LAST_DESCENDANT : String = _lastDescendant [static]
The last descendant of the current location, or null if the current location does not have children. | RelativeLocations | ||
| LAST_SIBLING : String = _lastSibling [static]
The last sibling of the current location. | RelativeLocations | ||
| LAST_STORYBOARD : String = _lastStoryboard [static]
The last storyboard. | RelativeLocations | ||
| NEXT_LINEAR : String = _nextLinear [static]
Ignoring hierarchy, the next item "down" from the current location. | RelativeLocations | ||
| NEXT_SIBLING : String = _nextSibling [static]
The next sibling of the current location, or null if the current location has no next sibling. | RelativeLocations | ||
| PARENT : String = _parent [static]
The parent of the current location, or null if the current location does not have a parent. | RelativeLocations | ||
| PREVIOUS_LINEAR : String = _previousLinear [static]
Ignoring hierarchy, the previous item "up" from the current location. | RelativeLocations | ||
| PREVIOUS_SIBLING : String = _previousSibling [static]
The previous sibling of the current location, or null if the current location has no previous sibling. | RelativeLocations | ||
| TOP_ANCESTOR : String = _topAncestor [static]
The topmost direct ancestor of the current location, or null if the current location does not have a parent. | RelativeLocations | ||
| isRelativeLocation | () | method |
public static function isRelativeLocation(locationName:String):Boolean
Determines if the passed in locationName is one of the defined constants.
Note that this method does not check for map contstants (current map/default map)
Parameters
locationName:String — Expression to check.
|
Boolean — true if the locationName is one of the defined
constants; otherwise false.
|
| CURRENT | Constant |
public static const CURRENT:String = _currentThe current location.
| CURRENT_MAP | Constant |
public static const CURRENT_MAP:StringThe current map.
| DEFAULT_MAP | Constant |
public static const DEFAULT_MAP:String = _defaultThe default map.
| FIRST_CHILD | Constant |
public static const FIRST_CHILD:String = _firstChild
The first child of the current location, or null if the current location has no children.
| FIRST_SIBLING | Constant |
public static const FIRST_SIBLING:String = _firstSiblingThe first sibling of the current location. If the current location has no previous sibling, the current location is returned.
| FIRST_STORYBOARD | Constant |
public static const FIRST_STORYBOARD:String = _firstStoryboardThe first storyboard.
| LAST_CHILD | Constant |
public static const LAST_CHILD:String = _lastChild
The last child of the current location, or null if the current location has no children.
| LAST_DESCENDANT | Constant |
public static const LAST_DESCENDANT:String = _lastDescendant
The last descendant of the current location, or null if the current location does not have children. The last
descendant is defined as the last linear storyboard which has the current location as an ancestor.
| LAST_SIBLING | Constant |
public static const LAST_SIBLING:String = _lastSiblingThe last sibling of the current location. If the current location has no next sibling, the current location is returned.
| LAST_STORYBOARD | Constant |
public static const LAST_STORYBOARD:String = _lastStoryboardThe last storyboard. The last storyboard is defined as the first storyboard's last sibling's last descendant.
| NEXT_LINEAR | Constant |
public static const NEXT_LINEAR:String = _nextLinearIgnoring hierarchy, the next item "down" from the current location.
| NEXT_SIBLING | Constant |
public static const NEXT_SIBLING:String = _nextSibling
The next sibling of the current location, or null if the current location has no next sibling.
| PARENT | Constant |
public static const PARENT:String = _parent
The parent of the current location, or null if the current location does not have a parent.
| PREVIOUS_LINEAR | Constant |
public static const PREVIOUS_LINEAR:String = _previousLinearIgnoring hierarchy, the previous item "up" from the current location.
| PREVIOUS_SIBLING | Constant |
public static const PREVIOUS_SIBLING:String = _previousSibling
The previous sibling of the current location, or null if the current location has no previous sibling.
| TOP_ANCESTOR | Constant |
public static const TOP_ANCESTOR:String = _topAncestor
The topmost direct ancestor of the current location, or null if the current location does not have a parent.