/** * Tells whether the visibility state of the dockable changed * @return whether the visibility state changed * @deprecated this method gets replaced by {@link #isShowingChanged()} */ @Deprecated @Todo( compatibility=Compatibility.BREAK_MAJOR, priority=Priority.ENHANCEMENT, target=Version.VERSION_1_1_3, description="remove this method" ) public boolean isVisibleChanged(){ return oldShowing != newShowing; }
/** * Tells whether this station is visible or not. For example a station on * a {@link JFrame} is not visible if the frame is minimized. * @return whether this station is visible * @deprecated use {@link #isStationShowing()} instead, this method will be removed in a future release */ @Deprecated @Todo( compatibility=Compatibility.BREAK_MAJOR, priority=Priority.ENHANCEMENT, target=Version.VERSION_1_1_3, description="remove this method" ) public boolean isStationVisible();
/** * Tells whether the visibility state of the dockable changed * @return whether the visibility state changed * @deprecated this method gets replaced by {@link #isShowingChanged()} */ @Deprecated @Todo( compatibility=Compatibility.BREAK_MAJOR, priority=Priority.ENHANCEMENT, target=Version.VERSION_1_1_3, description="remove this method" ) public boolean isVisibleChanged(){ return oldShowing != newShowing; }
/** * Tells whether the user could see the dockable before this event * @return the old visibility state * @deprecated replaced by {@link #getOldShowing()} */ @Deprecated @Todo( compatibility=Compatibility.BREAK_MAJOR, priority=Priority.ENHANCEMENT, target=Version.VERSION_1_1_3, description="remove this method" ) public boolean getOldVisible(){ return oldShowing; }
/** * Tells whether this <code>CDockable</code> is currently visible to the user. A <code>CDockable</code> * which is not {@link #isVisible() visible}, is not <code>dockable visible</code> either. The method * does not take into account that a frame may be positioned such that it is not entirely visible on the * screen. Neither does the method take into account, that a frame may be minimized. * @return <code>true</code> if the user should be able to see this item * @deprecated this method gets replaced by {@link #isShowing()}, which offers the exact same information. This method * will be removed in a future release */ @Deprecated @Todo( compatibility=Compatibility.BREAK_MAJOR, priority=Priority.ENHANCEMENT, target=Version.VERSION_1_1_3, description="remove this method" ) public boolean isDockableVisible();
/** * Tells whether the user could see the dockable before this event * @return the old visibility state * @deprecated replaced by {@link #getOldShowing()} */ @Deprecated @Todo( compatibility=Compatibility.BREAK_MAJOR, priority=Priority.ENHANCEMENT, target=Version.VERSION_1_1_3, description="remove this method" ) public boolean getOldVisible(){ return oldShowing; }
/** * Tells whether the user can see the dockable after this event * @return the new visibility state * @deprecated replaced by {@link #getNewShowing()} */ @Todo( compatibility=Compatibility.BREAK_MAJOR, priority=Priority.ENHANCEMENT, target=Version.VERSION_1_1_3, description="remove this method" ) @Deprecated public boolean getNewVisible(){ return newShowing; }
/** * Tells whether the visibility of the {@link #getDockable() dockable} changed. * @return whether the visibility changed * @see Dockable#isDockableShowing() * @deprecated use {@link #didShowingChange()} instead, this method will be removed in a future version */ @Deprecated @Todo( compatibility=Compatibility.BREAK_MAJOR, priority=Priority.ENHANCEMENT, target=Version.VERSION_1_1_3, description="remove this method" ) public boolean didVisibilityChange(){ return (flags & FLAG_VISIBILITY) == FLAG_VISIBILITY; }
/** * Tells whether the child <code>dockable</code> is visible or not. Visible * means that the {@link Dockable#getComponent() component} of <code>dockable</code> * can be seen by the user. The result must be <code>false</code> if * this station is not visible. * @param dockable the child whose visibility-state is questioned * @return whether <code>dockable</code> is visible or not * @see #isStationVisible() * @deprecated use {@link #isChildShowing(Dockable)} instead, this method will be removed in a future release */ @Todo( compatibility=Compatibility.BREAK_MAJOR, priority=Priority.ENHANCEMENT, target=Version.VERSION_1_1_3, description="remove this method" ) @Deprecated public boolean isVisible( Dockable dockable );
/** * Tells whether the visibility of the {@link #getDockable() dockable} changed. * @return whether the visibility changed * @see Dockable#isDockableShowing() * @deprecated use {@link #didShowingChange()} instead, this method will be removed in a future version */ @Deprecated @Todo( compatibility=Compatibility.BREAK_MAJOR, priority=Priority.ENHANCEMENT, target=Version.VERSION_1_1_3, description="remove this method" ) public boolean didVisibilityChange(){ return (flags & FLAG_VISIBILITY) == FLAG_VISIBILITY; }
/** * Tells whether the user can see the dockable after this event * @return the new visibility state * @deprecated replaced by {@link #getNewShowing()} */ @Todo( compatibility=Compatibility.BREAK_MAJOR, priority=Priority.ENHANCEMENT, target=Version.VERSION_1_1_3, description="remove this method" ) @Deprecated public boolean getNewVisible(){ return newShowing; }
/** * Tells whether this <code>CDockable</code> is currently visible to the user. A <code>CDockable</code> * which is not {@link #isVisible() visible}, is not <code>dockable visible</code> either. The method * does not take into account that a frame may be positioned such that it is not entierly visible on the * screen. Neither does the method take into account, that a frame may be minimized. * @return <code>true</code> if the user should be able to see this item * @deprecated this method gets replaced by {@link #isShowing()}, which offers the exact same information. This method * will be removed in a future release */ @Deprecated @Todo( compatibility=Compatibility.BREAK_MAJOR, priority=Priority.ENHANCEMENT, target=Version.VERSION_1_1_3, description="remove this method" ) public boolean isDockableVisible();
/** * Tells whether this {@link Dockable} can be seen by the user. A {@link Dockable} at least needs * to be registered as root-station on a {@link DockController}, or be a child of a root-station * to be visible.<br> * Implementations will assume that {@link Component}s which are {@link Component#isDisplayable() displayable} are * are visible to the user. * @return <code>true</code> if the user can actually see this dockable, <code>false</code> * otherwise * @deprecated replaced by {@link #isDockableShowing()}, this method will be removed in a future release */ @Deprecated @Todo( compatibility=Compatibility.BREAK_MAJOR, priority=Priority.ENHANCEMENT, target=Version.VERSION_1_1_3, description="remove this method" ) public boolean isDockableVisible();
/** * Sets the {@link Dockable} which should have the focus. * @param source the item to focus, may be <code>null</code> * @param component the {@link Component} which triggered this call for example because the user clicked with the mouse on it. * This method can assume that the focus will automatically be transferred to <code>component</code> by the Swing framework itself. * Can be <code>null</code>, in which case this method decides on its own which {@link Component} to focus. This method may or may * not do sanity checks concerning <code>component</code>. An invalid argument will silently be ignored and treated * as if it would be <code>null</code>. * @param force <code>true</code> if this controller must ensure * that all properties are correct, <code>false</code> if some * optimizations are allowed. Clients normally can set this argument * to <code>false</code>. * @param ensureFocusSet if <code>true</code>, then this method should make sure that either <code>focusedDockable</code> * itself or one of its {@link DockElementRepresentative} is the focus owner * @param ensureDockableFocused if <code>true</code>, then this method should make sure that <code>focusedDockable</code> * is the focus owner. This parameter is stronger that <code>ensureFocusSet</code> * @return whether focus could be transferred, a value of <code>null</code> indicates that {@link #isOnFocusing()} returned * <code>true</code> and the call was ignored * @deprecated this method will be replaced by {@link #focus(FocusRequest)} */ @Deprecated @Todo( compatibility=Compatibility.BREAK_MAJOR, description="remove this method", priority=Todo.Priority.ENHANCEMENT, target=Version.VERSION_1_1_3) public FocusVeto setFocusedDockable( DockElementRepresentative source, Component component, boolean force, boolean ensureFocusSet, boolean ensureDockableFocused );
/** * Sets the {@link Dockable} which should have the focus. * @param source the item to focus, may be <code>null</code> * @param component the {@link Component} which triggered this call for example because the user clicked with the mouse on it. * This method can assume that the focus will automatically be transfered to <code>component</code> by the Swing framework itself. * Can be <code>null</code>, in which case this method decides on its own which {@link Component} to focus. This method may or may * not do sanity checks concerning <code>component</code>. An invalid argument will silently be ignored and treated * as if it would be <code>null</code>. * @param force <code>true</code> if this controller must ensure * that all properties are correct, <code>false</code> if some * optimations are allowed. Clients normally can set this argument * to <code>false</code>. * @param ensureFocusSet if <code>true</code>, then this method should make sure that either <code>focusedDockable</code> * itself or one of its {@link DockElementRepresentative} is the focus owner * @param ensureDockableFocused if <code>true</code>, then this method should make sure that <code>focusedDockable</code> * is the focus owner. This parameter is stronger that <code>ensureFocusSet</code> * @return whether focus could be transfered, a value of <code>null</code> indicates that {@link #isOnFocusing()} returned * <code>true</code> and the call was ignored * @deprecated this method will be replaced by {@link #focus(FocusRequest)} */ @Deprecated @Todo( compatibility=Compatibility.BREAK_MAJOR, description="remove this method", priority=Todo.Priority.ENHANCEMENT, target=Version.VERSION_1_1_3) public FocusVeto setFocusedDockable( DockElementRepresentative source, Component component, boolean force, boolean ensureFocusSet, boolean ensureDockableFocused );
@Todo( target=Version.VERSION_1_1_3, priority=Priority.MINOR, compatibility=Compatibility.BREAK_MINOR, description="remove this constant without replacement" ) public static SingleTabDecider ALLWAYS = ALWAYS;
@Deprecated @Todo( compatibility=Compatibility.BREAK_MAJOR, priority=Priority.ENHANCEMENT, target=Version.VERSION_1_1_3, description="remove this method" ) public boolean isStationVisible(){ return isShowing(); }
@Deprecated @Todo( compatibility=Compatibility.BREAK_MAJOR, priority=Priority.ENHANCEMENT, target=Version.VERSION_1_1_3, description="remove this method" ) public boolean isVisible( Dockable dockable ){ return isStationVisible(); }
@Deprecated @Todo( compatibility=Compatibility.BREAK_MAJOR, priority=Priority.ENHANCEMENT, target=Version.VERSION_1_1_3, description="remove this method" ) public boolean isStationVisible(){ return isDockableVisible(); }
@Deprecated @Todo( compatibility=Compatibility.BREAK_MAJOR, priority=Priority.ENHANCEMENT, target=Version.VERSION_1_1_3, description="remove this method" ) public boolean isStationVisible(){ return isDockableVisible(); }