FrameSvc.LayoutConstraints Class
- public static class FrameSvc.LayoutConstraints
extends Object
implements Cloneable
Constraints used to add a view to the application layout.
Related Topics
FrameSvc.I.addView(String, String, boolean, boolean)
FrameSvc.I.addView(String, String, String, boolean, boolean)
FrameSvc.I.addView(String, FrameSvc.LayoutConstraints)
FrameSvc.I.addView(String, String, FrameSvc.LayoutConstraints)
-
Hierarchy
-
Object
FrameSvc.LayoutConstraints
-
All Implemented Interfaces
-
Cloneable
-
Enclosing class
-
FrameSvc
public boolean |
-
askAvailable
- If true, then the layout manager will query the availability state of
the specified view each time layout is recalculated.
|
public boolean |
-
exact
- True means position exactly based on destination view, for TABBED placement only.
|
public boolean |
-
focus
- Set focus to the added view immediately.
|
public boolean |
-
hasAction
- True if the view has its own menu action, and should be excluded from all generated menus
|
public boolean |
-
hasMenu
- True if the view will appear in a non-default generated menu, and should be
excluded from the default generated menu
|
public String |
-
icon
- Icon to show in menus and toolbars
|
public boolean |
-
insert
- Insert or append the view in the layout.
|
public String |
-
label
- Label used to display the view in the UI (required)
|
public boolean |
-
open
- Make at least the view's tab visible to the user.
|
public int |
-
orientation
- Orientation to use when inserting into the UI.
|
public double |
-
proportion
- Proportional dimension to comsume in split direction (n/a to TABBED and ROOT).
|
public String |
-
scope
- Scope in which the view is 'available' (optional)
May be a layout id or a document handler class.
|
public String |
-
viewClassDest
- Class name key of the view with which to share layout space.
|
public String |
-
viewIdDest
- Id key (may be null, if n/a) of the view with which to share layout space.
|
public boolean |
-
visible
- Make the view visible to the user.
|
askAvailable
public boolean askAvailable
- If true, then the layout manager will query the availability state of
the specified view each time layout is recalculated. The added view class
must implement IFrameView.
Related Topics
IFrameView.isAvailable()
exact
public boolean exact
- True means position exactly based on destination view, for TABBED placement only.
False will cause the new view to be positioned either at the beginning, or the end
of the tab set. only with exact=true can you position between existing tabs.
focus
public boolean focus
- Set focus to the added view immediately. (n/a if 'visible' is false)
hasAction
public boolean hasAction
- True if the view has its own menu action, and should be excluded from all generated menus
hasMenu
public boolean hasMenu
- True if the view will appear in a non-default generated menu, and should be
excluded from the default generated menu
icon
public String
icon
- Icon to show in menus and toolbars
insert
public boolean insert
- Insert or append the view in the layout.
view orientation 'ROOT': n/a
view orientation 'NORTH', 'SOUTH', 'EAST', 'WEST': closest to the app
frame edge, v. closest to the document.
view orientation 'HORIZONTAL': above v. below
view orientation 'VERTICAL': left v. right
view orientation 'TABBED': first v. last in the current set
label
public String
label
- Label used to display the view in the UI (required)
open
public boolean open
- Make at least the view's tab visible to the user. The view itself may not actually
be visible to the user.
orientation
public int orientation
- Orientation to use when inserting into the UI.
proportion
public double proportion
- Proportional dimension to comsume in split direction (n/a to TABBED and ROOT).
scope
public String
scope
- Scope in which the view is 'available' (optional)
May be a layout id or a document handler class.
An unavailable view does not show up in the UI at all (menus, and layout),
but if the user had it open the last time the view was available, then
it will return to the layout when it becomes available again.
viewClassDest
public String
viewClassDest
- Class name key of the view with which to share layout space.
Applicable only if 'orientation' is 'TABBED', 'HORIZONTAL', or 'VERTICAL'.
viewIdDest
public String
viewIdDest
- Id key (may be null, if n/a) of the view with which to share layout space.
Applicable only if 'orientation' is 'TABBED', 'HORIZONTAL', or 'VERTICAL'.
visible
public boolean visible
- Make the view visible to the user. Make it the active tab, if it is tabbed with
other views.
FrameSvc.LayoutConstraints
public FrameSvc.LayoutConstraints()
clone() Method
public Object
clone()
-
Overrides
-
Object.clone()